setElementDimension | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

setElementDimension

Client-side
Server-side
Shared

Pair: getElementDimension

This function allows you to set the dimension of an element.

OOP Syntax Help! I don't understand this!

  • Method:element:setDimension(...)
  • Variable: .dimension

Syntax 

​bool setElementDimension ( ​element theElement, ​int dimension )
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

  • bool: result

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

Code Examples

server

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
    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)

See Also

Element Functions
Element Events
Reference