SetObjectScale: Difference between revisions
Jump to navigation
Jump to search
(New page: __NOTOC__ {{client function}} This function changes the visible size of an object. ==Syntax== <syntaxhighlight lang="lua"> bool setObjectScale ( element theElement, float scale ) </syntaxhighlight> ===Required A...) |
m (Added default parameter values) |
||
| (14 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{client function}} | {{Server client function}} | ||
This function changes the visible size of an object. | This function changes the visible size of an object. | ||
{{Note|setObjectScale '''does not''' affect the collision models for the object, as such is unsuitable for use for interaction with players, vehicles or other objects.}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setObjectScale ( | bool setObjectScale ( object theObject, float scale [, float scaleY = scale, float scaleZ = scale ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[object]]:setScale|scale|getObjectScale}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theObject''': the [[object]] you wish to change the scale of. | ||
*'''scale''': a float containing the new scale. | *'''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== | ==Example== | ||
This example creates an antenna, and changes the size of it. | This example creates an antenna, and changes the size of it. | ||
<section name="Client" class="client" show="true"> | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- get the position of the player | -- get the position of the player | ||
| Line 25: | Line 29: | ||
antenna = createObject (1595, x + 2, y, z ) | antenna = createObject (1595, x + 2, y, z ) | ||
if ( antenna ) then -- if it was created | if ( antenna ) then -- if it was created | ||
-- set the scale | -- set the scale to half the normal scale | ||
setObjectScale ( antenna, 0.5) | setObjectScale ( antenna, 0.5) | ||
-- remove the collision | -- remove the collision | ||
| Line 31: | Line 35: | ||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{ | {{Client_object_functions}} | ||
Revision as of 14:14, 26 February 2018
This function changes the visible size of an object.
| Note: setObjectScale does not affect the collision models for the object, as such is unsuitable for use for interaction with players, vehicles or other objects. |
Syntax
bool setObjectScale ( object theObject, float scale [, float scaleY = scale, float scaleZ = scale ] )
OOP Syntax Help! I don't understand this!
- Method: object:setScale(...)
- Variable: .scale
- Counterpart: getObjectScale
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
- 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
- breakObject
- createObject
- getObjectMass
- getObjectScale
- getObjectProperty
- isObjectBreakable
- isObjectMoving
- moveObject
- respawnObject
- setObjectBreakable
- setObjectMass
- setObjectScale
- setObjectProperty
- stopObject
- toggleObjectRespawn