SetElementDimension

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

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

Returns

Returns 'true' if 'theElement' and 'dimension' is valid, 'false' otherwise.

Example

Click to expand [+]

Server

In this example the players 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 aswell
  end
end
addEventHandler ( "onPlayerEnterVehicle", 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 aswell
  end
end
addEventHandler ( "onPlayerExitVehicle", root, onPlayerExitVehicle )

See Also

• addElementDataSubscriber
• attachElements
• clearElementVisibleTo
• cloneElement
• createElement
• destroyElement
• detachElements
• getAllElementData
• getAttachedElements
• getElementAlpha
• getElementAttachedOffsets
• getElementAttachedTo
• getElementCollisionsEnabled
• getElementByID
• getElementByIndex
• getElementChild
• getElementChildren
• getElementChildrenCount
• getElementColShape
• getElementData
• getElementDimension
• getElementHealth
• getElementID
• getElementInterior
• getElementMatrix
• getElementModel
• getElementParent
• getElementPosition
• getElementRotation
• getElementSyncer
• getElementType
• getElementVelocity
• getElementZoneName
• getElementsByType
• getElementsWithinColShape
• getElementsWithinRange
• getLowLODElement
• getRootElement
• hasElementData
• hasElementDataSubscriber
• isElement
• isElementAttached
• isElementCallPropagationEnabled
• isElementDoubleSided
• isElementFrozen
• isElementInWater
• isElementLowLOD
• isElementVisibleTo
• isElementWithinColShape
• isElementWithinMarker
• removeElementData
• removeElementDataSubscriber
• setElementAlpha
• setElementAngularVelocity
• getElementAngularVelocity
• setElementAttachedOffsets
• setElementCallPropagationEnabled
• setElementCollisionsEnabled
• setElementData
• setElementDimension
• setElementDoubleSided
• setElementFrozen
• setElementHealth
• setElementID
• setElementInterior
• setElementModel
• setElementParent
• setElementPosition
• setElementRotation
• setElementSyncer
• setElementVelocity
• setElementVisibleTo
• setLowLODElement