GetElementZoneName: Difference between revisions
Jump to navigation
Jump to search
m (optional arg in syntax) |
mNo edit summary |
||
| Line 20: | Line 20: | ||
This example shows you how to return your own location by doing /loc in the chatbox or just loc in console | This example shows you how to return your own location by doing /loc in the chatbox or just loc in console | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function playerloc ( source ) | function playerloc ( source ) | ||
local playername = getClientName ( source ) | local playername = getClientName ( source ) | ||
| Line 26: | Line 25: | ||
outputChatBox ( "* " ..playername.. "'s Location: " ..location, root, 0, 255, 255 ) -- Output the player's name and zone name | outputChatBox ( "* " ..playername.. "'s Location: " ..location, root, 0, 255, 255 ) -- Output the player's name and zone name | ||
end | end | ||
addCommandHandler("loc", playerloc) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Element functions}} | {{Element functions}} | ||
Revision as of 15:09, 15 August 2007
This function allows you to retrieve the zone name of an element (eg. Verdant Bluffs or Ocean Docks)
Syntax
string getElementZoneName ( element theElement, [bool citiesonly=false] )
Required Arguments
- theElement: The element in which you'd like to retrieve the zone name from
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- citiesonly: An optional argument to choose if you want to return the city name (eg Las Venturas)
Returns
Returns the string of the elements zone name
Example
This example shows you how to return your own location by doing /loc in the chatbox or just loc in console
function playerloc ( source )
local playername = getClientName ( source )
local location = getElementZoneName ( source )
outputChatBox ( "* " ..playername.. "'s Location: " ..location, root, 0, 255, 255 ) -- Output the player's name and zone name
end
addCommandHandler("loc", playerloc)
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