This wiki is archived and useful information is being migrated to the main bzflag.org website

bz ePlayerSpawnEvent

From BZFlagWiki
Revision as of 17:26, 28 November 2007 by JeffM2501 (Talk | contribs)

Jump to: navigation, search
Picture Frame.png This page contains API documentation that needs to be reviewed and cleaned up. The information presented here is most likely correct but has not been verified, or may refer to an older version of the API.


BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.

BZFS Event. This page documents a BZFS event that is called by the game server to notify plug-ins of various actions and state changes in the game world.


Overview

The bz_ePlayerSpawnEvent is an API event that is called each time a player spawns in the world, either after joining or after being killed.

Data

bz_ePlayerSpawnEvent returns the bz_PlayerSpawnEventData data class.

name type value description
eventType bz_eEventType bz_ePlayerSpawnEvent
playerID int ID of the player who spawned
team bz_eTeamType The team the spawning player is a member of
pos float[3] Position of the spawning player
rot float Rotation of the spawning player
time double Time at which the player spawned

Uses

This event is a notification only event, none of the data returned can be changed.