OnClientPlayerSpawn: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
{{Client event}} | |||
__NOTOC__ | __NOTOC__ | ||
This event is | This event is triggered when any player, including a remote player, spawns. | ||
== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
team hisTeam | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''hisTeam''': A team element representing the team the player spawned on. | |||
==Source== | |||
The [[event system#Event source|source]] of this event is the [[player]] that spawned. | |||
==Example== | ==Example== | ||
This | This code will create an explosion for the local player when they spawn. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua">function explosionOnSpawn ( ) | ||
-- | -- get the spawned player's position | ||
local pX, pY, pZ = getElementPosition ( source ) | |||
-- | -- and create an explosion there | ||
createExplosion ( pX, pY, pZ, 6 ) | |||
end | |||
-- add this function as a handler for any player that spawns | |||
addEventHandler ( "onClientPlayerSpawn", getLocalPlayer(), explosionOnSpawn ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | |||
{{Event_functions}} |
Revision as of 12:50, 22 October 2007
This event is triggered when any player, including a remote player, spawns.
Parameters
team hisTeam
- hisTeam: A team element representing the team the player spawned on.
Source
The source of this event is the player that spawned.
Example
This code will create an explosion for the local player when they spawn.
function explosionOnSpawn ( ) -- get the spawned player's position local pX, pY, pZ = getElementPosition ( source ) -- and create an explosion there createExplosion ( pX, pY, pZ, 6 ) end -- add this function as a handler for any player that spawns addEventHandler ( "onClientPlayerSpawn", getLocalPlayer(), explosionOnSpawn )
See Also
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled