Difference between revisions of "SetElementDimension"

From Multi Theft Auto: Wiki
Jump to: navigation, search
m (Returns)
m (Returns)
Line 13: Line 13:
  
 
===Returns===
 
===Returns===
Returns ''true'' if '''theElement''' and '''dimension''' are valid, and if '''theElement''' is a player, then it has to be alive, ''false'' otherwise.
+
Returns ''true'' if '''theElement''' and '''dimension''' are valid, ''false'' otherwise.
  
 
==Example==
 
==Example==

Revision as of 12:14, 15 July 2013

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 are valid, false otherwise.

Example

Click to collapse [-]
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", getRootElement ( ), 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", getRootElement ( ), onPlayerExitVehicle )

See Also