SetElementDimension: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 13: Line 13:


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


==Example==
==Example==
<section name="Server" class="server" show="false">
<section name="Server" class="server" show="false">
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.
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">
<syntaxhighlight lang="lua">
function onPlayerEnterVehicle ( theVehicle, seat, jacked )
function onPlayerEnterVehicle ( theVehicle, seat, jacked )
  if ( getElementDimension ( source ) == 0 ) then -- if the player is in dimension 0
      if ( getElementDimension ( source ) == 0 ) then   -- if the player is in dimension 0
    setElementDimension ( source, 1 ) -- set his dimension to 1
            setElementDimension ( source, 1 )           -- set his dimension to 1
    setElementDimension ( theVehicle, 1 ) -- set his vehicle's dimension to 1 aswell
            setElementDimension ( theVehicle, 1 )       -- set his vehicle's dimension to 1 as well
  end
      end
end
end
addEventHandler ( "onPlayerEnterVehicle", root, onPlayerEnterVehicle )
addEventHandler ( "onPlayerEnterVehicle", getRootElement ( ), onPlayerEnterVehicle )


function onPlayerExitVehicle ( theVehicle, seat, jacker )
function onPlayerExitVehicle ( theVehicle, seat, jacker )
  if ( getElementDimension ( source ) == 1 ) then -- if the player is in dimension 1
      if ( getElementDimension ( source ) == 1 ) then   -- if the player is in dimension 1
    setElementDimension ( source, 0 ) -- set his dimension back to 0
            setElementDimension ( source, 0 )           -- set his dimension back to 0
    setElementDimension ( theVehicle, 0 ) -- set his vehicle's dimension back to 0 aswell
            setElementDimension ( theVehicle, 0 )       -- set his vehicle's dimension back to 0 as well
  end
      end
end
end
addEventHandler ( "onPlayerExitVehicle", root, onPlayerExitVehicle )
addEventHandler ( "onPlayerExitVehicle", getRootElement ( ), onPlayerExitVehicle )
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Revision as of 12:35, 16 August 2007

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 expand [+]
Server

See Also