GetObjectScale: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Server client function}} This function returns the visible size of an object. ==Syntax== <syntaxhighlight lang="lua"> float getObjectScale ( object theObject ) </syntaxhighlight> ===Require...") |
No edit summary |
||
| (8 intermediate revisions by 6 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}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theObject''': | *'''theObject''': the [[object]] you wish to return the scale of. | ||
===Returns=== | ===Returns=== | ||
* 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-only Example" class="client" show="true"> | |||
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("getscale", | |||
function() | |||
local theObject = createObject(1337, getElementPosition(localPlayer)) | |||
local x, y, z = getObjectScale(theObject) | |||
outputChatBox("Object scale: X: "..x..", Y: "..y.." Z: "..z.."") | |||
end | |||
) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Object_functions}} | {{Object_functions}} | ||
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 ExampleThis 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