SetElementInterior: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 11: Line 11:
*'''theElement:''' The element in which you'd like to set the interior of.
*'''theElement:''' The element in which you'd like to set the interior of.
*'''interior:''' The interior you want to set the element to. Valid values are 0 to 255.
*'''interior:''' The interior you want to set the element to. Valid values are 0 to 255.
===Returns===
Returns ''true'' if '''theElement''' and '''interior''' are valid arguments, ''false'' otherwise.


===Optional Arguments===
===Optional Arguments===
{{OptionalArg}}
* '''x:''' A floating point number representing the X coordinate on the map.
* '''x:''' A floating point number representing the X coordinate on the map.
* '''y:''' A floating point number representing the Y coordinate on the map.
* '''y:''' A floating point number representing the Y coordinate on the map.
* '''z:''' A floating point number representing the Z coordinate on the map.
* '''z:''' A floating point number representing the Z coordinate on the map.
===Returns===
Returns ''true'' if '''theElement''' and '''interior''' are valid arguments, ''false'' otherwise.


==Example==
==Example==

Revision as of 20:31, 14 August 2009

This function allows you to set the interior of any element. An interior is the current loaded place, 0 being outside.

Syntax

bool setElementInterior ( element theElement, int interior [, float x, float y, float z] )

Required Arguments

  • theElement: The element in which you'd like to set the interior of.
  • interior: The interior you want to set the element to. Valid values are 0 to 255.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • x: A floating point number representing the X coordinate on the map.
  • y: A floating point number representing the Y coordinate on the map.
  • z: A floating point number representing the Z coordinate on the map.

Returns

Returns true if theElement and interior are valid arguments, false otherwise.

Example

Click to collapse [-]
Server

In this example, if a player were to type /interior 1, they would be teleported into this interior 

function interior ( source, commandName, interior )
  --Let's see if they gave an interior ID
  if ( interior ) then
    --They did, so lets assign them to that interior and teleport them there (all in 1 function call!)
    setElementInterior ( source, interior, 2233.91, 1714.73, 1011.38 )
  else
    --They didn't give one, so set them to the interior they wanted, but don't teleport them.
    setElementInterior ( source, 0 )
  end
end
addCommandHandler ( "interior", interior )
Click to collapse [-]
Client

In this example, if a player were to type /interior 1, they would be teleported into this interior 

function interior ( commandName, interior )
  --Let's see if they gave a interior ID
  if ( interior ) then
    --They did, so let's assign them to that interior and teleport them there (all in 1 function call!)
    setElementInterior ( getLocalPlayer(), interior, 2233.91, 1714.73, 1011.38 )
  else
    --They didn't give one, so set them to the interior they wanted, but don't teleport them.
    setElementInterior ( getLocalPlayer(), 0 )
  end
end
addCommandHandler ( "interior", interior )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementInterior?oldid=21079"