ShowChat - Revision history

Lvrent at 21:37, 23 September 2021

2021-09-23T21:37:51Z

← Older revision		Revision as of 21:37, 23 September 2021
Line 13:		Line 13:

	===Optional Arguments===		===Optional Arguments===
	{{~~Updated~~ feature/item\|1.5.9\|1.5.8\|20898\|		{{Added feature/item\|1.5.9\|1.5.8\|20898\|
	*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 (''true'' when chat is hidden, ''false'' when chat is visible).		*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 (''true'' when chat is hidden, ''false'' when chat is visible).
	}}		}}

Lvrent at 21:37, 23 September 2021

2021-09-23T21:37:37Z

← Older revision		Revision as of 21:37, 23 September 2021
Line 13:		Line 13:

	===Optional Arguments===		===Optional Arguments===
	{{Updated feature/item~~\|3.0159~~\|1.5.9\|1.5.8\|20898\|		{{Updated feature/item\|1.5.9\|1.5.8\|20898\|
	*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 (''true'' when chat is hidden, ''false'' when chat is visible).		*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 (''true'' when chat is hidden, ''false'' when chat is visible).
	}}		}}
Line 29:		Line 29:

	===Optional Arguments===		===Optional Arguments===
	{{~~New~~ feature/item\|3.~~0159~~\|1.5.8\|20898\|		{{Added feature/item\|1.5.9\|1.5.8\|20898\|
	*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 (''true'' when chat is hidden, ''false'' when chat is visible).		*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 (''true'' when chat is hidden, ''false'' when chat is visible).
	}}		}}

Lvrent at 11:28, 23 September 2021

2021-09-23T11:28:49Z

← Older revision		Revision as of 11:28, 23 September 2021
Line 13:		Line 13:

	===Optional Arguments===		===Optional Arguments===
	{{~~New~~ feature/item\|3.0159\|1.5.8\|20898\|		{{Updated feature/item\|3.0159\|1.5.9\|1.5.8\|20898\|
	*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 (''true'' when chat is hidden, ''false'' when chat is visible).		*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 (''true'' when chat is hidden, ''false'' when chat is visible).
	}}		}}

LopSided at 01:18, 29 July 2021

2021-07-29T01:18:01Z

← Older revision		Revision as of 01:18, 29 July 2021
Line 14:		Line 14:
	===Optional Arguments===		===Optional Arguments===
	{{New feature/item\|3.0159\|1.5.8\|20898\|		{{New feature/item\|3.0159\|1.5.8\|20898\|
	*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.		*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 (''true'' when chat is hidden, ''false'' when chat is visible).
	}}		}}
	===Returns===		===Returns===
Line 30:		Line 30:
	===Optional Arguments===		===Optional Arguments===
	{{New feature/item\|3.0159\|1.5.8\|20898\|		{{New feature/item\|3.0159\|1.5.8\|20898\|
	*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.		*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 (''true'' when chat is hidden, ''false'' when chat is visible).
	}}		}}

LopSided at 01:12, 29 July 2021

2021-07-29T01:12:52Z

← Older revision		Revision as of 01:12, 29 July 2021
Line 11:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.		*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.

			===Optional Arguments===
	{{New feature/item\|3.0159\|1.5.8\|20898\|		{{New feature/item\|3.0159\|1.5.8\|20898\|
	*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.		*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.
Line 25:		Line 27:
	*'''thePlayer:''' The [[player]] whose chat is to be hidden or shown.		*'''thePlayer:''' The [[player]] whose chat is to be hidden or shown.
	*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.		*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.

			===Optional Arguments===
	{{New feature/item\|3.0159\|1.5.8\|20898\|		{{New feature/item\|3.0159\|1.5.8\|20898\|
	*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.		*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.

LopSided: Update to include new feature/item template for inputBlocked argument

2021-07-29T01:11:43Z

Update to include new feature/item template for inputBlocked argument

← Older revision		Revision as of 01:11, 29 July 2021
Line 6:		Line 6:
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool showChat ( bool show )		bool showChat ( bool show [, bool inputBlocked ] )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.		*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.
			{{New feature/item\|3.0159\|1.5.8\|20898\|
			*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.
			}}
	===Returns===		===Returns===
	Returns ''true'' if the player's chat was shown or hidden successfully, ''false'' otherwise.		Returns ''true'' if the player's chat was shown or hidden successfully, ''false'' otherwise.
Line 17:		Line 19:
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool showChat ( player thePlayer, bool show )		bool showChat ( player thePlayer, bool show [, bool inputBlocked ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 23:		Line 25:
	*'''thePlayer:''' The [[player]] whose chat is to be hidden or shown.		*'''thePlayer:''' The [[player]] whose chat is to be hidden or shown.
	*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.		*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.
			{{New feature/item\|3.0159\|1.5.8\|20898\|
			*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.
			}}

	===Returns===		===Returns===

Zelev: Undo revision 61740 by Zelev (talk)

2018-12-24T18:27:59Z

Undo revision 61740 by Zelev (talk)

← Older revision		Revision as of 18:27, 24 December 2018
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~Esta función es usada para mostrar y/o ocultar el~~ chat ~~del jugador~~.		This function is used to show or hide the player's chat.

	==Syntax==		==Syntax==
	<section name="~~Cliente~~" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool showChat ( bool show )		bool showChat ( bool show )
	</syntaxhighlight>		</syntaxhighlight>

	===~~Argumentos Requeridos~~===		===Required Arguments===
	*'''show:''' ~~Un valor~~ boolean ~~determinando si mostrar~~ (''true'') ~~o ocultar~~ (''false'') el chat.		*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.

	===Returns===		===Returns===
	~~Se vuelve~~ ''true'' ~~si el~~ chat ~~del jugador fue mostrado o ocultado con éxito~~, ''false'' ~~de lo contrario~~.		Returns ''true'' if the player's chat was shown or hidden successfully, ''false'' otherwise.
	</section>		</section>
	<section name="~~Servidor~~" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool showChat ( player thePlayer, bool show )		bool showChat ( player thePlayer, bool show )
	</syntaxhighlight>		</syntaxhighlight>

	===~~Argumentos Requeridos~~===		===Required Arguments===
	*'''thePlayer:''' El [[player]] ~~al cual se le muestra o oculta el~~ chat.		*'''thePlayer:''' The [[player]] whose chat is to be hidden or shown.
	*'''show:''' ~~Un valor~~ boolean ~~determinando si mostrar~~ (''true'') ~~o ocultar~~ (''false'') el chat.		*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.

	===Returns===		===Returns===
	~~Se vuelve~~ ''true'' ~~si el~~ chat ~~del jugador fue mostrado o ocultado con éxito~~, ''false'' ~~de lo contrario~~.		Returns ''true'' if the player's chat was shown or hidden successfully, ''false'' otherwise.
	</section>		</section>

	==~~Ejemplo~~==		==Example==
	<section name="~~Cliente~~" class="client" show="true">		<section name="Client" class="client" show="true">
	~~Este ejemplo alterna (muestra o oculta) el~~ chat ~~del jugador cuando presiona la tecla~~ "'''i'''".		This example toggle's the player's chat when they press the "'''i'''" key.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~El siguiente ejemplo es para todas las versiones hasta la~~ 1.4:		--This example below is for all versions until 1.4:
	local isChatVisible = true --~~Asumamos que el~~ chat es visible ~~tan pronto inicie el~~ resource.		local isChatVisible = true --Let's assume the chat is visible as soon as the resource starts.

	function chat(key, keyState)		function chat(key, keyState)
	if isChatVisible then --~~Revisa si el~~ chat ~~está~~ visible.		if isChatVisible then --Check or the chat is visible.
	showChat(false) --~~Si lo está~~, ~~ocúltalo~~.		showChat(false) --If it is, hide it.
	isChatVisible = false		isChatVisible = false
	else		else
	showChat(true) --~~Si no lo está~~, ~~muéstralo~~.		showChat(true) --If it is not, show it.
	isChatVisible = true		isChatVisible = true
	end		end
	end		end

	bindKey("i", "down", chat) --~~Haz una tecla de enlace (~~bind~~, bindea) para inciar la función tan pronto un jugador presione la tecla~~ 'i'		bindKey("i", "down", chat) --Make a bind key to start the function as soon as a player presses the key 'i'


	--~~El siguiente ejemplo es para las versiones~~ 1.4 ~~en adelante~~:		--This example below is for version 1.4 and up:
	function chat(key, keyState)		function chat(key, keyState)
	if isChatVisible() then --~~Revisa si el~~ chat ~~está~~ visible.		if isChatVisible() then --Check or the chat is visible.
	showChat(false) --~~Si lo está~~, ~~ocúltalo~~.		showChat(false) --If it is, hide it.
	else		else
	showChat(true) --~~Si no lo está~~, ~~muéstralo~~.		showChat(true) --If it is not, show it.
	end		end
	end		end

	bindKey("i", "down", chat) --~~Haz una tecla de enlace (~~bind~~, bindea) para iniciar la función tan pronto un jugador presione la tecla~~ 'i'		bindKey("i", "down", chat) --Make a bind key to start the function as soon as a player presses the key 'i'
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	==~~Ver también~~==		==See Also==
	{{Server functions}}		{{Server functions}}

Zelev: Spanish translated version/ versión traducida al español.

2018-12-24T18:14:39Z

Spanish translated version/ versión traducida al español.

← Older revision		Revision as of 18:14, 24 December 2018
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~This function is used to show or hide the player's~~ chat.		Esta función es usada para mostrar y/o ocultar el chat del jugador.

	==Syntax==		==Syntax==
	<section name="~~Client~~" class="client" show="true">		<section name="Cliente" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool showChat ( bool show )		bool showChat ( bool show )
	</syntaxhighlight>		</syntaxhighlight>

	===~~Required Arguments~~===		===Argumentos Requeridos===
	*'''show:''' A boolean ~~value determining whether to show~~ (''true'') ~~or hide~~ (''false'') ~~the~~ chat.		*'''show:''' Un valor boolean determinando si mostrar (''true'') o ocultar (''false'') el chat.

	===Returns===		===Returns===
	~~Returns~~ ''true'' ~~if the player's~~ chat ~~was shown or hidden successfully~~, ''false'' ~~otherwise~~.		Se vuelve ''true'' si el chat del jugador fue mostrado o ocultado con éxito, ''false'' de lo contrario.
	</section>		</section>
	<section name="~~Server~~" class="server" show="true">		<section name="Servidor" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool showChat ( player thePlayer, bool show )		bool showChat ( player thePlayer, bool show )
	</syntaxhighlight>		</syntaxhighlight>

	===~~Required Arguments~~===		===Argumentos Requeridos===
	*'''thePlayer:''' ~~The~~ [[player]] ~~whose~~ chat ~~is to be hidden or shown~~.		*'''thePlayer:''' El [[player]] al cual se le muestra o oculta el chat.
	*'''show:''' A boolean ~~value determining whether to show~~ (''true'') ~~or hide~~ (''false'') ~~the~~ chat.		*'''show:''' Un valor boolean determinando si mostrar (''true'') o ocultar (''false'') el chat.

	===Returns===		===Returns===
	~~Returns~~ ''true'' ~~if the player's~~ chat ~~was shown or hidden successfully~~, ''false'' ~~otherwise~~.		Se vuelve ''true'' si el chat del jugador fue mostrado o ocultado con éxito, ''false'' de lo contrario.
	</section>		</section>

	==~~Example~~==		==Ejemplo==
	<section name="~~Client~~" class="client" show="true">		<section name="Cliente" class="client" show="true">
	~~This example toggle's the player's~~ chat ~~when they press the~~ "'''i'''" ~~key~~.		Este ejemplo alterna (muestra o oculta) el chat del jugador cuando presiona la tecla "'''i'''".
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~This example below is for all versions until~~ 1.4:		--El siguiente ejemplo es para todas las versiones hasta la 1.4:
	local isChatVisible = true --~~Let's assume the~~ chat is visible ~~as soon as the~~ resource ~~starts~~.		local isChatVisible = true --Asumamos que el chat es visible tan pronto inicie el resource.

	function chat(key, keyState)		function chat(key, keyState)
	if isChatVisible then --~~Check or the~~ chat is visible.		if isChatVisible then --Revisa si el chat está visible.
	showChat(false) --~~If it is~~, ~~hide it~~.		showChat(false) --Si lo está, ocúltalo.
	isChatVisible = false		isChatVisible = false
	else		else
	showChat(true) --~~If it is not~~, ~~show it~~.		showChat(true) --Si no lo está, muéstralo.
	isChatVisible = true		isChatVisible = true
	end		end
	end		end

	bindKey("i", "down", chat) --~~Make a~~ bind ~~key to start the function as soon as a player presses the key~~ 'i'		bindKey("i", "down", chat) --Haz una tecla de enlace (bind, bindea) para inciar la función tan pronto un jugador presione la tecla 'i'


	--~~This example below is for version~~ 1.4 ~~and up~~:		--El siguiente ejemplo es para las versiones 1.4 en adelante:
	function chat(key, keyState)		function chat(key, keyState)
	if isChatVisible() then --~~Check or the~~ chat is visible.		if isChatVisible() then --Revisa si el chat está visible.
	showChat(false) --~~If it is~~, ~~hide it~~.		showChat(false) --Si lo está, ocúltalo.
	else		else
	showChat(true) --~~If it is not~~, ~~show it~~.		showChat(true) --Si no lo está, muéstralo.
	end		end
	end		end

	bindKey("i", "down", chat) --~~Make a~~ bind ~~key to start the function as soon as a player presses the key~~ 'i'		bindKey("i", "down", chat) --Haz una tecla de enlace (bind, bindea) para iniciar la función tan pronto un jugador presione la tecla 'i'
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	==~~See Also~~==		==Ver también==
	{{Server functions}}		{{Server functions}}

Et-win: /* Example */ Added an example for MTA 1.4 and up, since 'isChatVisible' is now a function in MTA itself.

2014-08-25T20:18:48Z

Example: Added an example for MTA 1.4 and up, since 'isChatVisible' is now a function in MTA itself.

← Older revision		Revision as of 20:18, 25 August 2014
Line 32:		Line 32:
	This example toggle's the player's chat when they press the "'''i'''" key.		This example toggle's the player's chat when they press the "'''i'''" key.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local isChatVisible = true -- ~~let~~'s assume the chat is visible		--This example below is for all versions until 1.4:
	function chat ( key, keyState )		local isChatVisible = true --Let's assume the chat is visible as soon as the resource starts.
	if isChatVisible then -- ~~if it's on~~
	showChat ( false ) -- ~~turn~~ it ~~off~~		function chat(key, keyState)
			if isChatVisible then --Check or the chat is visible.
			showChat(false) --If it is, hide it.
	isChatVisible = false		isChatVisible = false
	else		else
	showChat ( true ) -- if it~~'s off~~		showChat(true) --If it is not, show it.
	isChatVisible = true ~~-- turn it on~~		isChatVisible = true
	end		end
	end		end
	bindKey ( "i", "down", chat ) -- the player's "i" key ~~will toggle~~ the ~~chat~~
			bindKey("i", "down", chat) --Make a bind key to start the function as soon as a player presses the key 'i'


			--This example below is for version 1.4 and up:
			function chat(key, keyState)
			if isChatVisible() then --Check or the chat is visible.
			showChat(false) --If it is, hide it.
			else
			showChat(true) --If it is not, show it.
			end
			end

			bindKey("i", "down", chat) --Make a bind key to start the function as soon as a player presses the key 'i'
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Awwu at 16:11, 4 April 2009

2009-04-04T16:11:23Z

← Older revision		Revision as of 16:11, 4 April 2009
Line 6:		Line 6:
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool showChat(bool show)		bool showChat ( bool show )
	</syntaxhighlight>		</syntaxhighlight>

			===Required Arguments===
			*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.

			===Returns===
			Returns ''true'' if the player's chat was shown or hidden successfully, ''false'' otherwise.
	</section>		</section>
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool showChat(player thePlayer, bool show)		bool showChat ( player thePlayer, bool show )
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	===Required Arguments===		===Required Arguments===
	*'''~~player~~:''' ~~the~~ player.		*'''thePlayer:''' The [[player]] whose chat is to be hidden or shown.
	*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.		*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.

	===Returns===		===Returns===
	Returns ''true'' if the player's chat was shown or hidden successfully, ''false'' otherwise.		Returns ''true'' if the player's chat was shown or hidden successfully, ''false'' otherwise.
			</section>

	==Example==		==Example==
Line 26:		Line 32:
	This example toggle's the player's chat when they press the "'''i'''" key.		This example toggle's the player's chat when they press the "'''i'''" key.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local isChatVisible = true -- let's assume the chat is visible		local isChatVisible = true -- let's assume the chat is visible
	function chat(key, keyState)		function chat ( key, keyState )
	if isChatVisible then -- if it's on		if isChatVisible then -- if it's on
	showChat(false) -- turn it off		showChat ( false ) -- turn it off
	isChatVisible = false		isChatVisible = false
	else		else
	showChat(true) -- if it's off		showChat ( true ) -- if it's off
	isChatVisible = true -- turn it on		isChatVisible = true -- turn it on
	end		end
	end		end
	bindKey ("i", "down~~", "toggle chat~~", chat) -- the player's "i" key will toggle the chat		bindKey ( "i", "down", chat ) -- the player's "i" key will toggle the chat
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>