SetObjectScale - Revision history

Srslyyyy: Improve example.

2022-09-02T14:37:34Z

Improve example.

← Older revision		Revision as of 14:37, 2 September 2022
Line 24:		Line 24:
	<section name="Client" class="client" show="true">		<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
	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 to half the normal 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		end
	</syntaxhighlight>		</syntaxhighlight>

2018-02-26T14:14:45Z

Added default parameter values

← Older revision		Revision as of 14:14, 26 February 2018
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setObjectScale ( object theObject, float scale [, float scaleY, float scaleZ ] )		bool setObjectScale ( object theObject, float scale [, float scaleY = scale, float scaleZ = scale ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[object]]:setScale\|scale\|getObjectScale}}		{{OOP\|\|[[object]]:setScale\|scale\|getObjectScale}}

2014-10-04T22:51:26Z

← Older revision		Revision as of 22:51, 4 October 2014
Line 9:		Line 9:
	{{OOP\|\|[[object]]:setScale\|scale\|getObjectScale}}		{{OOP\|\|[[object]]:setScale\|scale\|getObjectScale}}
	===Required Arguments===		===Required Arguments===
	*'''theObject''': ~~The~~ object you wish to change the scale of.		*'''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.		*'''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.

Line 17:		Line 17:

	===Returns===		===Returns===
	~~Returns~~ ''true'' if the scale was set properly, ''false'' otherwise.		* ''true'' if the scale was set properly.
			* ''false'' otherwise.

	==Example==		==Example==

2014-08-18T03:40:47Z

← Older revision		Revision as of 03:40, 18 August 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server 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==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

2014-07-12T06:35:08Z

OOP syntax added

← Older revision		Revision as of 06:35, 12 July 2014
Line 7:		Line 7:
	bool setObjectScale ( object theObject, float scale [, float scaleY, float scaleZ ] )		bool setObjectScale ( object theObject, float scale [, float scaleY, float scaleZ ] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[object]]:setScale\|scale\|getObjectScale}}
	===Required Arguments===		===Required Arguments===
	*'''theObject''': The object you wish to change the scale of.		*'''theObject''': The object you wish to change the scale of.

2014-06-08T11:44:43Z

← Older revision		Revision as of 11:44, 8 June 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setObjectScale ( object theObject, float scale [, float scaleY~~] [~~, float scaleZ] )		bool setObjectScale ( object theObject, float scale [, float scaleY, float scaleZ ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 13:		Line 13:

	===Optional Arguments===		===Optional Arguments===
	*'''~~scaleX~~''': a float containing the new scale on the Y axis		*'''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

2014-06-08T11:20:33Z

← Older revision		Revision as of 11:20, 8 June 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setObjectScale ( object theObject, float scale )		bool setObjectScale ( object theObject, float scale [, float scaleY] [, float scaleZ] )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''theObject''': The object you wish to change the scale of.		*'''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.		*'''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===
			*'''scaleX''': a float containing the new scale on the Y axis
			*'''scaleZ''': a float containing the new scale on the Z axis

	===Returns===		===Returns===

2012-08-05T16:19:04Z

← Older revision		Revision as of 16:19, 5 August 2012
Line 2:		Line 2:
	{{Server 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. 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.

	~~{{New feature\|3.0110\|1.1\|~~
	~~Only available client-side for 1.0.x~~
	}}

	==Syntax==		==Syntax==

2011-09-13T11:57:29Z

← Older revision		Revision as of 11:57, 13 September 2011
Line 4:		Line 4:

	{{New feature\|3.0110\|1.1\|		{{New feature\|3.0110\|1.1\|
	~~Available server-side.~~ Only available client-side for 1.0.x		Only available client-side for 1.0.x
	}}		}}

2011-05-19T02:15:22Z

← Older revision		Revision as of 02:15, 19 May 2011
Line 4:		Line 4:

	{{New feature\|3.0110\|1.1\|		{{New feature\|3.0110\|1.1\|
	Available server-side. Only available client-side for 1.0.~~4 and lower.~~		Available server-side. Only available client-side for 1.0.x
	}}		}}