SetObjectScale: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setObjectScale ( object theObject, float scale [, float scaleY | bool setObjectScale ( object theObject, float scale [, float scaleY, float scaleZ ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 13: | Line 13: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
*''' | *'''scaleY''': a float containing the new scale on the Y axis | ||
*'''scaleZ''': a float containing the new scale on the Z axis | *'''scaleZ''': a float containing the new scale on the Z axis | ||
Revision as of 11:44, 8 June 2014
This function changes the visible size of an object. It is very important to note that this does not affect the collision models for the object, as such this is unsuitable for use for interaction with players, vehicles or other objects.
Syntax
bool setObjectScale ( object theObject, float scale [, float scaleY, float scaleZ ] )
Required Arguments
- theObject: The object you wish to change the scale of.
- scale: a float containing the new scale. 1.0 is the standard scale, with 0.5 being half the size and 2.0 being twice the size. If the scaleY is set, this will be scaleX.
Optional Arguments
- scaleY: a float containing the new scale on the Y axis
- scaleZ: a float containing the new scale on the Z axis
Returns
Returns true if the scale was set properly, false otherwise.
Example
This example creates an antenna, and changes the size of it.
Click to collapse [-]
Client-- get the position of the player
local x, y, z = getElementPosition(getLocalPlayer())
-- create the object
antenna = createObject (1595, x + 2, y, z )
if ( antenna ) then -- if it was created
-- set the scale to half the normal scale
setObjectScale ( antenna, 0.5)
-- remove the collision
setElementCollisionsEnabled (antenna, false)
end
See Also
- createObject
- getObjectScale
- moveObject
- setObjectScale
- stopObject
- getObjectMass
- getObjectProperty
- setObjectMass
- setObjectProperty