HasElementData - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:19:10Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:19, 7 November 2024
Line 43:		Line 43:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	~~==Requirements==~~
	~~{{Requirements\|1.5.7-9.20447\|1.5.7-9.20447\|}}~~

	==See Also==		==See Also==
	{{Element functions}}		{{Element functions}}

Qaisjp: ver

2020-05-20T10:34:47Z

ver

← Older revision		Revision as of 10:34, 20 May 2020
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	{{New feature/item\|3.0158\|1.5.8\|20447\|		{{New feature/item\|3.0158\|1.5.7\|20447\|
	This function checks if an element has [[element data]] available under a certain key.}}		This function checks if an element has [[element data]] available under a certain key.}}

Qaisjp: typo

2020-05-20T10:33:29Z

typo

← Older revision		Revision as of 10:33, 20 May 2020
Line 1:		Line 1:
	__NOTOC__ {{Server client function}}		__NOTOC__
			{{Server client function}}
	{{New feature/item\|3.0158\|1.5.8\|20447\|		{{New feature/item\|3.0158\|1.5.8\|20447\|
	This function checks if an element has [[element data]] available under a certain key.		This function checks if an element has [[element data]] available under a certain key.}}
	}}

	==Syntax==		==Syntax==

Qaisjp: fix version

2020-05-20T10:33:05Z

fix version

← Older revision		Revision as of 10:33, 20 May 2020
Line 1:		Line 1:
	__NOTOC__		__NOTOC__ {{Server client function}}
	{{Server client function}}		{{New feature/item\|3.0158\|1.5.8\|20447\|
	This function checks if an element has [[element data]] available under a certain key.		This function checks if an element has [[element data]] available under a certain key.
			}}

	==Syntax==		==Syntax==

Luxy.c: Fix version number

2020-03-20T18:47:59Z

Fix version number

← Older revision		Revision as of 18:47, 20 March 2020
Line 44:		Line 44:

	==Requirements==		==Requirements==
	{{Requirements\|1.5.7-20447\|1.5.7-20447\|}}		{{Requirements\|1.5.7-9.20447\|1.5.7-9.20447\|}}

	==See Also==		==See Also==
	{{Element functions}}		{{Element functions}}

Lordmau5: Improve upon the example

2020-03-20T18:24:04Z

Improve upon the example

← Older revision		Revision as of 18:24, 20 March 2020
Line 22:		Line 22:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function favoriteAnimal ( source, commandName, playerName )		function favoriteAnimal ( source, commandName, playerName )
	if ( playerName ) then -- see if a player was specified		local thePlayer = source
	thePlayer = getPlayerFromName ( playerName ) -- get the player element for the specified player		if playerName then -- see if a player was specified
	if ( thePlayer ) then -- if ~~one was found...~~		thePlayer = getPlayerFromName (playerName) -- get the player element for the specified player
	~~if ( hasElementData ( thePlayer, "favoriteAnimal" ) ) then -- check if the~~ player ~~has a favorite animal set~~		if not thePlayer then -- if we still couldn't find a player with the specified name...
	~~local favoriteAnimal = getElementData ( thePlayer, "favoriteAnimal" ) -- get~~ the ~~player's favorite animal~~		outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error
	~~outputChatBox ( getPlayerName ( thePlayer ).~~.~~"'s favorite animal is: "~~..~~favoriteAnimal, source ) -- output the player's favorite animal~~		return
	~~else~~		end
	~~outputChatBox ( getPlayerName ( thePlayer ).." does not have a favorite animal!", source ) -- output the player's lack of a favorite animal~~		end
	~~end~~
	~~else~~		if hasElementData ( thePlayer, "favoriteAnimal" ) then -- check if the player has a favorite animal set
	outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error		local favoriteAnimal = getElementData ( thePlayer, "favoriteAnimal" ) -- get the player's favorite animal
	end		outputChatBox ( getPlayerName ( thePlayer ).."'s favorite animal is: "..favoriteAnimal, source ) -- output the player's favorite animal
	~~else~~		else
	if ( hasElementData ( ~~source~~, "favoriteAnimal" ) ) then -- check if the player has a favorite animal set		outputChatBox ( getPlayerName ( thePlayer ).." does not have a favorite animal!", source ) -- output the player's lack of a favorite animal
	local favoriteAnimal = getElementData ( ~~source~~, "favoriteAnimal" ) -- get the player's favorite animal		end
	outputChatBox ( "~~Your~~ favorite animal is: "..favoriteAnimal, source ) -- output the player's favorite animal
	else
	outputChatBox ( "~~You do~~ not have a favorite animal!", source ) -- output the player's lack of a favorite animal
	~~end~~
	end
	end		end
	-- Add a console command joinTime, that takes an optional parameter of a player's name		-- Add a console command joinTime, that takes an optional parameter of a player's name

Botder: Credits: Lordmau5

2020-03-20T18:16:43Z

Credits: Lordmau5

New page

__NOTOC__
{{Server client function}}
This function checks if an element has [[element data]] available under a certain key.

==Syntax==
<syntaxhighlight lang="lua">bool hasElementData ( element theElement, string key [, bool inherit = true] )</syntaxhighlight>
{{OOP||[[element]]:hasData}}

===Required Arguments===
*'''theElement:''' This is the element with data you want to check.
*'''key:''' The name of the element data entry you want to check for. (Maximum 31 characters.)

===Optional Arguments===
*'''inherit:''' - toggles whether or not the function should go up the hierarchy to find the requested key in case the specified element doesn't have it.

===Returns===
This function returns ''true'' if the element contains element data for ''key'', or ''false'' if the element doesn't exist or there is no data associated with the ''key''.

==Example==
This example outputs a player's favorite animal using a console function 'favoriteAnimal' if they have one set.
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
function favoriteAnimal ( source, commandName, playerName )
if ( playerName ) then -- see if a player was specified
thePlayer = getPlayerFromName ( playerName ) -- get the player element for the specified player
if ( thePlayer ) then -- if one was found...
if ( hasElementData ( thePlayer, "favoriteAnimal" ) ) then -- check if the player has a favorite animal set
local favoriteAnimal = getElementData ( thePlayer, "favoriteAnimal" ) -- get the player's favorite animal
outputChatBox ( getPlayerName ( thePlayer ).."'s favorite animal is: "..favoriteAnimal, source ) -- output the player's favorite animal
else
outputChatBox ( getPlayerName ( thePlayer ).." does not have a favorite animal!", source ) -- output the player's lack of a favorite animal
end
else
outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error
end
else
if ( hasElementData ( source, "favoriteAnimal" ) ) then -- check if the player has a favorite animal set
local favoriteAnimal = getElementData ( source, "favoriteAnimal" ) -- get the player's favorite animal
outputChatBox ( "Your favorite animal is: "..favoriteAnimal, source ) -- output the player's favorite animal
else
outputChatBox ( "You do not have a favorite animal!", source ) -- output the player's lack of a favorite animal
end
end
end
-- Add a console command joinTime, that takes an optional parameter of a player's name
addCommandHandler ( "favoriteAnimal", favoriteAnimal )
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.7-20447|1.5.7-20447|}}

==See Also==
{{Element functions}}