IsPlayerNametagShowing

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

This function will allow you to determine if a player's name tag is currently showing.

Syntax

bool isPlayerNametagShowing ( player thePlayer )

OOP Syntax Help! I don't understand this!

Method: player:isNametagShowing(...)
Variable: .nametagShowing
Counterpart: setPlayerNametagShowing


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 = getPlayerFromName ( who )    -- search for the player
	else
		whoNick = getPlayerName(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