IsPlayerNametagShowing: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 15: Line 15:
===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 the player's name tag is showing, ''false'' otherwise.
Returns ''true'' if successful, ''false'' otherwise.


==Example==  
==Example==  

Revision as of 05:13, 11 April 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 does...

addCommandHandler ( "nametagstatus", "outputTagStatus" )
function outputTagStatus ( player, commandName )
tagstatus = isPlayerNametagShowing ( player )
--Asks if the commandhandler activator's tag is showing and stores
--it to tagstatus as true or false
	if tagstatus == true then
	outputChatBox ( "Your tag is visible" )
	--output that name tag is showing because tagstatus is true
	else
	outputChatBox ( "Your tag is not visible" )
	--output that name tag is not showing because tagstatus is false
	end
end

See Also