GetObjectProperty: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0157|1.5.6|14370|This function gets a property of the specified object.}} ==Syntax== <syntaxhighlight lang="lua">mixe...") |
m (Fixed argument list) |
||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">mixed getObjectProperty ( object theObject, string property )</syntaxhighlight> | <syntaxhighlight lang="lua">mixed getObjectProperty ( object theObject, string property [ , var value1, ... ] )</syntaxhighlight> | ||
{{OOP||[[object]]:getProperty||setProperty}} | {{OOP||[[object]]:getProperty||setProperty}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
Revision as of 23:15, 8 February 2019
This function gets a property of the specified object.
Syntax
mixed getObjectProperty ( object theObject, string property [ , var value1, ... ] )
OOP Syntax Help! I don't understand this!
- Method: object:getProperty(...)
- Counterpart: setProperty
Required Arguments
- theObject: the object you wish to get a property of.
- property:: the property you want to get the value of:
- "all" - table with values of all properties below (OOP method: getProperties)
- "mass" - float
- "turn_mass" - float
- "air_resistance" - float
- "elasticity" - float
- "center_of_mass" - Vector3D - (x, y, z)
- "buoyancy" - float
Returns
On success: table for all, 3 floats for center_of_mass or float for other properties
On failure: false
Example
Click to collapse [-]
ClientaddEventHandler("onClientResourceStart", resourceRoot, function()
local theObject = createObject(980, 0, 0, 0) -- create an object
if theObject then
setObjectProperty(theObject, "center_of_mass", 0, -1, 0) -- set it's center of mass
local x, y, z = getObjectProperty(theObject, "center_of_mass") -- get it's center of mass
outputChatBox("Object's center of mass: "..tostring(x)..", "..tostring(y)..", "..tostring(z))
end
end)
See Also
- createObject
- getObjectScale
- moveObject
- setObjectScale
- stopObject
- getObjectMass
- getObjectProperty
- setObjectMass
- setObjectProperty