GM/PlayerInitialSpawn

From Garry's Mod
(Difference between revisions)
Jump to: navigation, search
(Added warning about sending net messages here.)
 
Line 5: Line 5:
  
 
{{Note|This hook is called before the player has fully loaded, when the player is still in seeing the "Starting Lua" screen. For example, trying to use the {{ClassFunction|Entity|GetModel}} function will return the default model ("player/default.mdl")}}
 
{{Note|This hook is called before the player has fully loaded, when the player is still in seeing the "Starting Lua" screen. For example, trying to use the {{ClassFunction|Entity|GetModel}} function will return the default model ("player/default.mdl")}}
 +
{{Warning|Due to the above note, sending {{Lib|net}} messages to the spawned player in this hook is highly unreliable, and they most likely won't be received. See https://github.com/Facepunch/garrysmod-requests/issues/718. A quick and dirty work-around is to delay any sending using {{LibraryFunction|timer|Simple}} with at least 5 seconds delay.}}
 
|Realm=Server
 
|Realm=Server
 
|Predicted=No
 
|Predicted=No

Latest revision as of 23:05, 12 October 2019

 GM:PlayerInitialSpawn( )

Contents

Description

Called when the player spawns for the first time.

See GM:PlayerSpawn for a hook called every player spawn.

NOTE

This hook is called before the player has fully loaded, when the player is still in seeing the "Starting Lua" screen. For example, trying to use the Entity:GetModel function will return the default model ("player/default.mdl")

WARNING

Due to the above note, sending net library messages to the spawned player in this hook is highly unreliable, and they most likely won't be received. See https://github.com/Facepunch/garrysmod-requests/issues/718. A quick and dirty work-around is to delay any sending using timer.Simple with at least 5 seconds delay.

Arguments

Player player

The player who spawned.

Arguments

boolean transition

If true, the player just spawned from a map transition.

Examples

Example

Prints the name of the player joining.

function GM:PlayerInitialSpawn(ply)
	print( ply:GetName().." joined the server.\n" )
end

-- That way you are overriding the default hook
-- you can use hook.Add to make more functions get called when this event occurs
local function spawn(ply)
	print( ply:GetName().." joined the game.\n")
end
hook.Add( "PlayerInitialSpawn", "some_unique_name", spawn )

Output:

<somebody> joined the game
Personal tools
Navigation