IsPlayerNametagShowing: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Also added client-side according to Google Code.)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server client function}}
{{New feature|3|1.0|Serverside only in DP2.x}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function will allow you to determine if a player's name tag is currently showing.
This function will allow you to determine if a player's name tag is currently showing.

Revision as of 16:12, 5 January 2009

Serverside only in DP2.x This function will allow you to determine if a player's name tag is currently showing.

Syntax

bool isPlayerNametagShowing ( player thePlayer )

Required Arguments

  • thePlayer: The player whose current name tag condition you want to check

Returns

Returns true if the player's name tag is being shown, false otherwise.

Example

This example toggles a player's nametag. If no playername is given, it toggles the nametag of the player who entered the command. 

function toggleNametag(sourcePlayer, command, who)
	local tplayer = sourcePlayer                -- by default, toggle the name tag of the player who issued the command
	if ( who ) then                             -- if there was a nick entered in the command
		tplayer = getPlayerFromNick(who)    -- search for the player
	else
		whoNick = getClientName(sourcePlayer)
	end
	if (tplayer ~= false) then                               -- if the player was found (or no playername was entered)
		if isPlayerNametagShowing(tplayer) then          -- if the nametag is shown
			setPlayerNametagShowing(tplayer, false)  -- hide it
			outputChatBox(who .. "'s nametag is now hidden", sourcePlayer)  -- output a message to the player who entered the command
		else                                             -- if the nametag is not shown
			setPlayerNametagShowing(tplayer, true)   -- show it
			outputChatBox(who .. "'s nametag is now showing", sourcePlayer) -- output a message to the player who entered the command
		end
	else
		outputChatBox("Player not found.", sourcePlayer)
	end
end
addCommandHandler("toggleNametag", toggleNametag)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsPlayerNametagShowing?oldid=18116"