SpawnPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
Line 2: Line 2:
{{Server function}}
{{Server function}}
This function spawns the player at an arbitary point on the map.<br>
This function spawns the player at an arbitary point on the map.<br>
'''Note:''' All players have their camera initially faded out after connect. To ensure that the camera is faded in, please do a [[fadeCamera]] after.
 
'''Note:''' [[setCameraTarget]] must be used to focus on the player. Also, all players have their camera initially faded out after connect. To ensure that the camera is faded in, please do a [[fadeCamera]] after.
 


==Syntax==
==Syntax==

Revision as of 18:23, 6 June 2008

This function spawns the player at an arbitary point on the map.

Note: setCameraTarget must be used to focus on the player. Also, all players have their camera initially faded out after connect. To ensure that the camera is faded in, please do a fadeCamera after.


Syntax

bool spawnPlayer ( player thePlayer, float x, float y, float z, [ int rotation = 0, int skinID = 0, int interior = 0, int dimension = 0, team theTeam = nil ] )

Required Arguments

  • thePlayer: The player you want to spawn
  • x: The x co-ordinate to spawn the player at
  • y: The y co-ordinate to spawn the player at
  • z: The z co-ordinate to spawn the player at

Optional Arguments

  • rotation: rotation of the player on spawn
  • skinID: players skin on spawn
  • interior: interior the player will spawn into
  • dimension: The ID of the dimension that the player should be in
  • theTeam: the team the player will join

Returns

Returns true if the player was spawned successfully, false otherwise.

Example

This example spawns all the players in the middle of the game map.

-- Get a table of all the players
players = getElementsByType ( "player" )
-- Go through every player
for playerKey, playerValue in ipairs(players) do
	-- Spawn them at the desired coordinates
	spawnPlayer ( playerValue, 0.0, 0.0, 5.0, 90.0, 0 )
end

See Also