From Multi Theft Auto: Wiki
Jump to navigation Jump to search

This function allows you to set the dimension of any element. The dimension determines what/who the element is visible to.


bool setElementDimension ( element theElement, int dimension )

OOP Syntax Help! I don't understand this!

Method: element:setDimension(...)
Variable: .dimension
Counterpart: getElementDimension

Required Arguments

  • theElement: The element in which you'd like to set the dimension of.
  • dimension: An integer representing the dimension ID. You can also use -1 to make the element visible in all dimensions (only valid to objects). Valid values are 0 to 65535.


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


Click to collapse [-]

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.

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
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
addEventHandler ( "onPlayerVehicleExit", root, onPlayerExitVehicle )


If you want to use the -1 dimension parameter.

Minimum server version 1.5.4
Minimum client version 1.5.4

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.5.4" client="1.5.4" />

See Also