SpawnPlayer: Difference between revisions

Latest revision as of 22:44, 6 September 2024

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

[[{{{image}}}\|link=\|]]	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 = getPlayerTeam(thePlayer) ] )

OOP Syntax Help! I don't understand this!

Method: player:spawn(...)

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: player's skin on spawn. Character Skins
interior: interior the player will spawn into. Interior IDs
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
local players = getElementsByType ( "player" )
-- Go through every player
for _, player in ipairs(players) do
	-- Spawn them at the desired coordinates
	spawnPlayer ( player, 0.0, 0.0, 5.0, 90.0, 0 )
	fadeCamera ( player, true)
	setCameraTarget ( player, player )
end

This example spawns a player when he logs in.

spawnTeam = createTeam ("Teamname", 255, 0, 0) -- Create team to spawn.
function spawnOnLogin (prevA, curA )
	outputChatBox ("Welcome to ...", source, 255, 0, 0, false)
	spawnPlayer (source, 0, 0, 5, 0, math.random (0,288), 0, 0, spawnTeam) -- spawns player with random skin
	fadeCamera (source, true)
	setCameraTarget (source, source)
end
addEventHandler("onPlayerLogin", root, spawnOnLogin)

@@ Line 1: / Line 1: @@
-__NOTOC__
+{{Server function}}
-This function spawns the player at a spawnpoint or at an arbitary point on the map.
+__NOTOC__
+This function spawns the player at an arbitrary point on the map.<br>
+{{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==
 <syntaxhighlight lang="lua">
-bool spawnPlayer ( player thePlayer, element spawnpoint )
+bool spawnPlayer ( player thePlayer, float x, float y, float z, [ int rotation = 0, int skinID = 0, int interior = 0, int dimension = 0, team theTeam = getPlayerTeam(thePlayer) ] )
-</syntaxhighlight>
-'''OR'''
-<syntaxhighlight lang="lua">
-bool spawnPlayer ( player thePlayer, float x, float y, float z, int rotation, int skinID )
 </syntaxhighlight>
+{{OOP||[[player]]:spawn||}}
+===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.
-===Required Arguments===
+===Optional Arguments===
-*'''thePlayer:''' the player to spawn
+*'''rotation:''' rotation of the player on spawn.
-*'''spawnpoint:''' the spawnpoint element at which to spawn the player
+*'''skinID:''' player's skin on spawn. [[Character Skins]]
-*'''x:''' The x co-ordinate to spawn the player at
+*'''interior:''' interior the player will spawn into. [[Interior IDs]]
-*'''y:''' The x co-ordinate to spawn the player at
+*'''dimension:''' The ID of the [[dimension]] that the player should be in.
-*'''z:''' The x co-ordinate to spawn the player at
+*'''theTeam:''' the team the player will join.
-*'''rotation:''' rotation of the player on spawn
-*'''skinID:''' players skin on spawn
 ===Returns===
 Returns ''true'' if the player was spawned successfully, ''false'' otherwise.
 ==Example==
-This example spawns all the players in the map at the first spawnpoint there is.
+This example spawns all the players in the middle of the game map.
 <syntaxhighlight lang="lua">
 -- Get a table of all the players
-players = getElementsByType ( "player" )
+local players = getElementsByType ( "player" )
--- Get a table of all the spawnpoints
-spawnpoints = getElementByType ( "spawnpoint" )
 -- Go through every player
-for playerKey, playerValue in players do
+for _, player in ipairs(players) do
-	-- Spawn them at the first spawnpoint
+	-- Spawn them at the desired coordinates
-	spawnPlayer ( playerValue, spawnpoints[1] )
+	spawnPlayer ( player, 0.0, 0.0, 5.0, 90.0, 0 )
+	fadeCamera ( player, true)
+	setCameraTarget ( player, player )
+end
+</syntaxhighlight>
+This example spawns a player '''when he logs in.'''
+<syntaxhighlight lang="lua">
+spawnTeam = createTeam ("Teamname", 255, 0, 0) -- Create team to spawn.
+function spawnOnLogin (prevA, curA )
+	outputChatBox ("Welcome to ...", source, 255, 0, 0, false)
+	spawnPlayer (source, 0, 0, 5, 0, math.random (0,288), 0, 0, spawnTeam) -- spawns player with random skin
+	fadeCamera (source, true)
+	setCameraTarget (source, source)
 end
+addEventHandler("onPlayerLogin", root, spawnOnLogin)
 </syntaxhighlight>
 ==See Also==
-{{Player_Functions}}
+{{Player functions|server}}
+[[ru:spawnPlayer]]