Fernando187: Remove obsolete Requirements section

2024-11-07T17:16:39Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:16, 7 November 2024
Line 38:		Line 38:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
	~~==Requirements==~~
	~~If you want to use the -1 dimension parameter.~~
	~~{{Requirements\|1.5.4\|1.5.4\|}}~~

	==See Also==		==See Also==

Surge: Created page with "{{Server client function}} NOTOC This function allows you to set the dimension of any element. The dimension determines what/who the element is visible to. ==Syntax==..."

2018-12-08T21:24:09Z

Created page with "{{Server client function}} __NOTOC__ This function allows you to set the dimension of any element. The dimension determines what/who the element is visible to. ==Syntax==..."

New page

{{Server client function}}
__NOTOC__
This function allows you to set the [[dimension]] of any element. The dimension determines what/who the element is visible to.

==Syntax==
<syntaxhighlight lang="lua">
bool setElementDimension ( element theElement, int dimension )
</syntaxhighlight>
{{OOP||[[element]]:setDimension|dimension|getElementDimension}}

===Required Arguments===
*'''theElement:''' The element in which you'd like to set the dimension of.
*'''dimension:''' An integer representing the dimension ID. {{New feature/item|3.0154|1.5.3|11199|You can also use '''-1''' to make the element visible in all dimensions (only valid to objects).}} Valid values are 0 to 65535.

===Returns===
Returns ''true'' if '''theElement''' and '''dimension''' are valid, ''false'' otherwise.
Also returns false if '''theElement''' is a player and it's not alive.

==Example==
<section name="Server" class="server" show="true">
In this example the player's dimension is set to ID 1 when they enter a vehicle, and set back to dimension 0 when they exit the vehicle.
<syntaxhighlight lang="lua">
function onPlayerEnterVehicle ( theVehicle, seat, jacked )
if ( getElementDimension ( source ) == 0 ) then -- if the player is in dimension 0
setElementDimension ( source, 1 ) -- set his dimension to 1
setElementDimension ( theVehicle, 1 ) -- set his vehicle's dimension to 1 as well
end
end
addEventHandler ( "onPlayerVehicleEnter", root, onPlayerEnterVehicle )

function onPlayerExitVehicle ( theVehicle, seat, jacker )
if ( getElementDimension ( source ) == 1 ) then -- if the player is in dimension 1
setElementDimension ( source, 0 ) -- set his dimension back to 0
setElementDimension ( theVehicle, 0 ) -- set his vehicle's dimension back to 0 as well
end
end
addEventHandler ( "onPlayerVehicleExit", root, onPlayerExitVehicle )
</syntaxhighlight>
</section>
==Requirements==
If you want to use the -1 dimension parameter.
{{Requirements|1.5.4|1.5.4|}}

==See Also==
{{Element functions}}

[[en:setElementDimension]]
[[de:setElementDimension]]

HU/setElementDimension - Revision history

Fernando187: Remove obsolete Requirements section

Surge: Created page with "{{Server client function}} __NOTOC__ This function allows you to set the dimension of any element. The dimension determines what/who the element is visible to. ==Syntax==..."

Surge: Created page with "{{Server client function}} NOTOC This function allows you to set the dimension of any element. The dimension determines what/who the element is visible to. ==Syntax==..."