SetObjectScale: Difference between revisions

Latest revision as of 14:37, 2 September 2022

This function changes the visible size of an object.

[[{{{image}}}\|link=\|]]	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(localPlayer)

-- Create the object

local antennaObject = createObject(1595, x + 2, y, z)

if antennaObject then -- If it was created
	-- Set the scale to half the normal scale

	setObjectScale(antennaObject, 0.5)

	-- Remove the collision

	setElementCollisionsEnabled(antennaObject, false)
end

@@ Line 1: / Line 1: @@
 __NOTOC__
-{{client function}}
+{{Server client function}}
-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.
+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==
 <syntaxhighlight lang="lua">
-bool setObjectScale ( element theElement, float scale )
+bool setObjectScale ( object theObject, float scale [, float scaleY = scale, float scaleZ = scale ] )
 </syntaxhighlight>
+{{OOP||[[object]]:setScale|scale|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.
-===Required Arguments===
+===Optional Arguments===
-*'''theElement''': The element you wish to change the size of.
+*'''scaleY''': a float containing the new scale on the Y axis
-*'''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.
+*'''scaleZ''': a float containing the new scale on the Z axis
 ===Returns===
-Returns true if the scale was set properly, false otherwise.
+* ''true'' if the scale was set properly.
+* ''false'' otherwise.
 ==Example==
 This example creates an antenna, and changes the size of it.
+<section name="Client" class="client" show="true">
 <syntaxhighlight lang="lua">
--- get the position of the player
+-- Get the position of the player
-local x, y, z = getElementPosition(getLocalPlayer())
--- create the object
+local x, y, z = getElementPosition(localPlayer)
-antenna = createObject (1595, x + 2, y, z )
-if ( antenna ) then -- if it was created
+-- Create the object
-	-- set the scale
-	setObjectScale ( antenna, 0.5)
+local antennaObject = createObject(1595, x + 2, y, z)
-	-- remove the collision
-        setElementCollisionsEnabled (antenna, false)
+if antennaObject then -- If it was created
+	-- Set the scale to half the normal scale
+	setObjectScale(antennaObject, 0.5)
+	-- Remove the collision
+	setElementCollisionsEnabled(antennaObject, false)
 end
 </syntaxhighlight>
+</section>
 ==See Also==
-{{Object functions}}
+{{Client_object_functions}}