GetObjectScale: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP syntax added)
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float getObjectScale ( object theObject )
float, float, float getObjectScale ( object theObject )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[object]]:getScale|scale|setObjectScale}}
{{OOP||[[Object]]:getScale|scale|setObjectScale}}
===Required Arguments===
===Required Arguments===
*'''theObject''': The object you wish to return the scale of.
*'''theObject''': the [[object]] you wish to return the scale of.


===Returns===
===Returns===
Returns a [[float]] indicating the scale of the object, if successful. ''false'' otherwise.
* Three [[float]] values indicating the scale of the object on the x, y, and z axis if successful, ''false'' otherwise.


==Example==
==Example==
<section name="Client" class="client" show="true">
<section name="Client-only Example" class="client" show="true">
This example adds a command ''get_scale'' which create object and prints out a scale of the object.
This example adds a command named ''getscale'' which creates an object and prints out the scale of it.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler( 'get_scale',
addCommandHandler("getscale",
function( )
    function()
local uObject = createObject( 1337, getElementPosition( localPlayer ) )
local theObject = createObject(1337, getElementPosition(localPlayer))
outputChatBox( string.format( 'Object scale is %s !', getObjectScale( uObject ) ) )
local x, y, z = getObjectScale(theObject)
end
outputChatBox("Object scale: X: "..x..", Y: "..y.." Z: "..z.."")
    end
)
)
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 14:19, 2 February 2021

This function returns the visible size of an object.

Syntax

float, float, float getObjectScale ( object theObject )

OOP Syntax Help! I don't understand this!

Method: Object:getScale(...)
Variable: .scale
Counterpart: setObjectScale


Required Arguments

  • theObject: the object you wish to return the scale of.

Returns

  • Three float values indicating the scale of the object on the x, y, and z axis if successful, false otherwise.

Example

Click to collapse [-]
Client-only Example

This example adds a command named getscale which creates an object and prints out the scale of it.

addCommandHandler("getscale",
    function()
	local theObject = createObject(1337, getElementPosition(localPlayer))
	local x, y, z = getObjectScale(theObject)
	outputChatBox("Object scale: X: "..x..", Y: "..y.." Z: "..z.."")
    end
)

See Also