GetObjectProperty

From Multi Theft Auto: Wiki
Jump to: navigation, search

FROM VERSION 1.5.6 r14370 ONWARDS
This function gets a property of the specified object.

Syntax

mixed getObjectProperty ( object theObject, string property )

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
  • "accuracy" - 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 [-]
Client
addEventHandler("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

FROM VERSION 1.5.6 r14370 ONWARDS