IsPlayerNametagShowing: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 16: Line 16:
===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if successful, ''false'' otherwise.
Returns ''true'' if the player's name tag is being shown, ''false'' otherwise.


==Example==  
==Example==  
Line 23: Line 23:
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function toggleNametag(player,command,who)
function toggleNametag(sourcePlayer, command, who)
local tplayer = player -- define 'tplayer' as the player who called the command
local tplayer = sourcePlayer                -- by default, toggle the name tag of the player who issued the command
if (who ~= nil) then -- if there was a nick entered in the command
if ( who ) then                             -- if there was a nick entered in the command
tplayer = getPlayerFromNick(who) -- search for the player
tplayer = getPlayerFromNick(who)   -- search for the player
else
else
who = getClientName(player)
whoNick = getClientName(sourcePlayer)
end
end
if (tplayer ~= false) then -- if the player was found (or no playername was entered)
if (tplayer ~= false) then                               -- if the player was found (or no playername was entered)
if (isPlayerNametagShowing(tplayer) == true) then -- if the nametag is shown
if isPlayerNametagShowing(tplayer) then         -- if the nametag is shown
setPlayerNametagShowing(tplayer,false) -- hide it
setPlayerNametagShowing(tplayer, false) -- hide it
outputChatBox("Nametag is now hidden for "..who,player) -- output a message to the player who entered the command
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
else                                             -- if the nametag is not shown
setPlayerNametagShowing(tplayer,true) -- show it
setPlayerNametagShowing(tplayer, true)   -- show it
outputChatBox("Nametag is now showing for "..who,player) -- output a message to the player who entered the command
outputChatBox(who .. "'s nametag is now showing", sourcePlayer) -- output a message to the player who entered the command
end
end
else
else
outputChatBox("Player not found.",player)
outputChatBox("Player not found.", sourcePlayer)
end
end
end
end
addCommandHandler("toggleNametag",toggleNametag)
addCommandHandler("toggleNametag", toggleNametag)
</syntaxhighlight>
</syntaxhighlight>


Revision as of 20:16, 16 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 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=10552"