IsPlayerNametagShowing: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
<!-- 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 12:03, 7 August 2007

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 successful, 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(player,command,who)
	local tplayer = player -- define 'tplayer' as the player who called the command
	if (who ~= nil) then -- if there was a nick entered in the command
		tplayer = getPlayerFromNick(who) -- search for the player
	else
		who = getClientName(player)
	end
	if (tplayer ~= false) then -- if the player was found (or no playername was entered)
		if (isPlayerNametagShowing(tplayer) == true) then -- if the nametag is shown
			setPlayerNametagShowing(tplayer,false) -- hide it
			outputChatBox("Nametag is now hidden for "..who,player) -- output a message to the player who entered the command
		else -- if the nametag is not shown
			setPlayerNametagShowing(tplayer,true) -- show it
			outputChatBox("Nametag is now showing for "..who,player) -- output a message to the player who entered the command
		end
	else
		outputChatBox("Player not found.",player)
	end
end
addCommandHandler("toggleNametag",toggleNametag)

See Also