HasElementData: Difference between revisions
Jump to navigation
Jump to search
(Credits: Lordmau5) |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
(5 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} | ||
This function checks if an element has [[element data]] available under a certain key. | {{New feature/item|3.0158|1.5.7|20447| | ||
This function checks if an element has [[element data]] available under a certain key.}} | |||
==Syntax== | ==Syntax== | ||
Line 22: | Line 23: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function favoriteAnimal ( source, commandName, playerName ) | function favoriteAnimal ( source, commandName, playerName ) | ||
if | local thePlayer = source | ||
if playerName then -- see if a player was specified | |||
thePlayer = getPlayerFromName (playerName) -- get the player element for the specified player | |||
if not thePlayer then -- if we still couldn't find a player with the specified name... | |||
outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error | |||
return | |||
end | |||
end | |||
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 | |||
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 | ||
Line 47: | Line 43: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
==See Also== | ==See Also== | ||
{{Element functions}} | {{Element functions}} |
Latest revision as of 17:19, 7 November 2024
This function checks if an element has element data available under a certain key.
Syntax
bool hasElementData ( element theElement, string key [, bool inherit = true] )
OOP Syntax Help! I don't understand this!
- Method: 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.
Click to collapse [-]
Serverfunction favoriteAnimal ( source, commandName, playerName ) local thePlayer = source if playerName then -- see if a player was specified thePlayer = getPlayerFromName (playerName) -- get the player element for the specified player if not thePlayer then -- if we still couldn't find a player with the specified name... outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error return end end 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 end -- Add a console command joinTime, that takes an optional parameter of a player's name addCommandHandler ( "favoriteAnimal", favoriteAnimal )
See Also
- attachElements
- createElement
- destroyElement
- detachElements
- getAttachedElements
- getElementAlpha
- getElementAttachedOffsets
- getElementAttachedTo
- getElementByIndex
- getElementByID
- getElementChild
- getElementChildren
- getElementChildrenCount
- getElementCollisionsEnabled
- getElementColShape
- getElementData
- getAllElementData
- hasElementData
- getElementDimension
- getElementHealth
- getElementID
- getElementInterior
- getElementMatrix
- getElementModel
- getElementParent
- getElementPosition
- getElementRotation
- getElementsByType
- getElementsWithinColShape
- getElementsWithinRange
- getElementType
- getElementVelocity
- getLowLODElement
- getRootElement
- isElement
- isElementAttached
- isElementCallPropagationEnabled
- isElementDoubleSided
- isElementFrozen
- isElementInWater
- isElementLowLOD
- isElementWithinColShape
- isElementWithinMarker
- setElementAlpha
- setElementAngularVelocity
- getElementAngularVelocity
- setElementAttachedOffsets
- setElementCallPropagationEnabled
- setElementCollisionsEnabled
- setElementData
- setElementDimension
- setElementDoubleSided
- setElementFrozen
- setElementHealth
- setElementID
- setElementInterior
- setElementModel
- setElementParent
- setElementPosition
- setElementRotation
- setElementVelocity
- setLowLODElement
- getPedContactElement
- getResourceDynamicElementRoot
- getResourceRootElement