Squirrel/Server/Events/Player/onPlayerJoin
From Liberty Unleashed Wiki
(Difference between revisions)
| Line 1: | Line 1: | ||
| − | + | {{Squirrel/Title|onPlayerJoin}} | |
| − | This is called when a player joins the server. This is fired ''after'' files and data | + | This is called when a player joins the server. This is fired ''after'' files and data have been sent to the client |
== Syntax == | == Syntax == | ||
| Line 6: | Line 6: | ||
<code>function onPlayerJoin( Player plr )</code> | <code>function onPlayerJoin( Player plr )</code> | ||
| − | == | + | === Arguments === |
| − | * '''plr''' - The pointer of the | + | * '''plr''' - The pointer of the player who joined |
| + | |||
| + | === Returns === | ||
| + | |||
| + | This event does not handle return values. | ||
== Example == | == Example == | ||
| − | This will say | + | This will say welcome to the player when they join the server. |
<code lang="squirrel"> | <code lang="squirrel"> | ||
| Line 18: | Line 22: | ||
{ | { | ||
MessagePlayer( "Welcome " + player.Name + " to the server!", player ); | MessagePlayer( "Welcome " + player.Name + " to the server!", player ); | ||
| + | |||
| + | return 1; | ||
} | } | ||
</code> | </code> | ||
| Line 23: | Line 29: | ||
=== Notes === | === Notes === | ||
| − | The | + | The functions [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and [[Squirrel/Server/Functions/Players/Name|Player.Name]] were used in this example. More info about them can be found in the corresponding pages. |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Events/Player}} | {{Squirrel/Server/Events/Player}} | ||
Latest revision as of 19:07, 22 December 2010
This is called when a player joins the server. This is fired after files and data have been sent to the client
[edit] Syntax
[edit] Arguments
- plr - The pointer of the player who joined
[edit] Returns
This event does not handle return values.
[edit] Example
This will say welcome to the player when they join the server.
[edit] Notes
The functions MessagePlayer and Player.Name were used in this example. More info about them can be found in the corresponding pages.
[edit] Related Functions
- onPlayerAction
- onPlayerArmourChange
- onPlayerCashChange
- onPlayerChat
- onPlayerCommand
- onPlayerConnect
- onPlayerDeath
- onPlayerFall
- onPlayerHealthChange
- onPlayerIslandChange
- onPlayerJoin
- onPlayerKeyStateChange
- onPlayerKill
- onPlayerPart
- onPlayerScoreChange
- onPlayerSkinChange
- onPlayerSpawn
- onPlayerUpdate
- onPlayerTeamChange
- onPlayerUseDetonator
- onPlayerVirtualWorldChange
- onPlayerWeaponChange
