Resource:Spawnmanager/createSpawnpoint: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Server function}} This function creates a spawnpoint. ==Syntax== <syntaxhighlight lang="lua"> spawnpoint createSpawnpoint ( float x, float y, float z, [ float rotation = 0, int skin = 0, ...)
 
mNo edit summary
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
spawnpoint createSpawnpoint ( float x, float y, float z, [ float rotation = 0, int skin = 0,  int interior, int dimension ] )
spawnpoint createSpawnpoint ( float x, float y, float z, [ float rotation = 0, int skin = 0,  int interior = 0, int dimension = 0 ] )
</syntaxhighlight>  
</syntaxhighlight>  


Line 16: Line 16:
*'''rotation:''' A floating point number representing the spawn's rotation about the Z axis in degrees.
*'''rotation:''' A floating point number representing the spawn's rotation about the Z axis in degrees.
*'''skin:''' An integer representing the skin ID (see [[Character_Skins|character skins]]).
*'''skin:''' An integer representing the skin ID (see [[Character_Skins|character skins]]).
*'''interior:''' An integer representing the interior in which the spawnpoint spawns players.
*'''dimension:''' An integer representing the diimension in which the spawnpoint spawns players.


===Returns===
===Returns===
Returns the [[spawnpoint]] element if creation was successful, ''false'' otherwise.
Returns the spawnpoint element if creation was successful, ''false'' otherwise.


==Example==  
==Example==  
Line 33: Line 35:
addCommandHandler( "mark", createSP )
addCommandHandler( "mark", createSP )
</syntaxhighlight>
</syntaxhighlight>
==See Also==
{{Spawnpoint functions}}

Revision as of 19:29, 19 October 2007

This function creates a spawnpoint.

Syntax

spawnpoint createSpawnpoint ( float x, float y, float z, [ float rotation = 0, int skin = 0,  int interior = 0, int dimension = 0 ] )

Required 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.

Optional Arguments

  • rotation: A floating point number representing the spawn's rotation about the Z axis in degrees.
  • skin: An integer representing the skin ID (see character skins).
  • interior: An integer representing the interior in which the spawnpoint spawns players.
  • dimension: An integer representing the diimension in which the spawnpoint spawns players.

Returns

Returns the spawnpoint element if creation was successful, false otherwise.

Example

This function lets the player create a new spawnpoint where he stands, with the skin of his choice.

function createSP( source, command, skin )
      local x, y, z = getElementPosition( source ) --Get the players location
      local rot = getPlayerRotation( source ) --Get the players rotation
      local theSpawnpoint = call(getResourceFromName("spawnmanager", "createSpawnpoint", x, y, z, rot, skin ) --Create the spawnpoint.
      if ( theSpawnpoint ) then
            outputConsole ( "Spawnpoint created.", source ) --notify the player if it was successful
      end
end
addCommandHandler( "mark", createSP )