BZFlagWiki - User contributions [en]

Bz eGetPlayerInfoEvent

2007-11-30T21:57:54Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} {{API_Docs_that_need_work}} ==Overview== The '''bz_eGetPlayerInfoEvent''' is an API event that is called to tell plugins about a new user and find out...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}
{{API_Docs_that_need_work}}

==Overview==
The '''bz_eGetPlayerInfoEvent''' is an API event that is called to tell plugins about a new user and find out their permissions. A plugin can use this to modify the state of being administrator, being verified and being registered of every user.

==Data==
'''bz_eGetPlayerInfoEvent''' returns the '''bz_GetPlayerInfoEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGetPlayerInfoEvent
|-
|playerID
|int
|The identification number of the player
|-
|callsign
|[[bz_ApiString]]
|The callsign of the player
|-
|ipAddress
|[[bz_ApiString]]
|The IP address of the player
|-
|team
|[[bz_eTeamType]]
|The team the player belongs to
|-
|admin
|bool
|This flag is set to true if the player is an administrator.
|-
|verified
|bool
|True if the user has authenticated with the login system. Comparable to a user having a "+" in the scoreboard.
|-
|registered
|bool
|This flag is set to true if the player is registered with the server, as opposed to being verified with the global login system (see the verified flag).
|-
|eventTime
|double
|The time of the event
|}
==Uses==
Some data in this event can be modified, namely the following flags: admin, verified, registered. A plugin can, for example, let every other user be an admin.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eAllowPlayer

2007-11-30T21:33:25Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} {{API_Docs_that_need_work}} ==Overview== The '''bz_eAllowPlayer''' is an API event that is called each time a player joins to allow a plug-in to overr...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}
{{API_Docs_that_need_work}}

==Overview==
The '''bz_eAllowPlayer''' is an API event that is called each time a player joins to allow a plug-in to override the servers allow or deny choice.
==Data==
'''bz_eAllowPlayer''' returns the '''bz_AllowPlayerEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eAllowPlayer
|-
|playerID
|int
|Each client has a player ID, even if that client is not yet in the game yet. This way, every client can be identified using an integer value.
|-
|callsign
|[[bz_ApiString]]
|The player's callsign
|-
|ipAddress
|[[bz_ApiString]]
|The IP address of the client which is trying to get into the game
|-
|reason
|[[bz_ApiString]]
|If a plugin denies the entrance of a player, then that plugin can explain why in this field.
|-
|allow
|bool
|This value should be set to true by the plugin if that plugin decided to allow the player to enter the game, and false otherwise.
|-
|eventTime
|double
|This value is the time at which the client requested to enter the game (and thus the event was created).
|}
==Uses==
A plugin can use this event to use an alternative to a ban list to decide whether a user should be allowed to play on the server. For example, if the server load is temporarily high, then a plugin could deny the entrance of even more users temporarily.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eGetWorldEvent

2007-11-30T20:45:43Z

Tulcod:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eGetWorldEvent''' is an API event that is called when the world is defined.

==Data==
'''bz_eGetWorldEvent''' returns the '''bz_GetWorldEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGetWorldEvent
|-
|generated
|bool
|Set to true if the world is generated (ie, not literally loaded from a file)
|-
|ctf
|bool
|Set to true if the game is a [[CTF]]-type game
|-
|rabit
|bool
|Set to true if the game is a [[Rabbit Hunt]]-type game
|-
|openFFA
|bool
|Set to true if the game is a [[Free For All]]-type game
|-
|worldFile
|[[bz_ApiString]]
|Path to the world file, set to "" (empty string) if not used
|-
|eventTime
|double
|Time of the event
|}
==Uses==
This event is a notification only event, none of the data returned can be changed.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eGetWorldEvent

2007-11-30T20:45:11Z

Tulcod:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eGetWorldEvent''' is an API event that is called when the world is defined.

==Data==
'''bz_eGetWorldEvent''' returns the '''bz_GetWorldEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGetWorldEvent
|-
|generated
|bool
|Set to true if the world is generated (ie, not literally loaded from a file)
|-
|ctf
|bool
|Set to true if the game is a [[CTF]]-type game
|-
|rabit
|bool
|Set to true if the game is a [[Rabbit Hunt]]-type game
|-
|openFFA
|bool
|Set to true if the game is a [[Free For All]]-type game
|-
|worldFile
|bz_ApiString
|Path to the world file, set to "" (empty string) if not used
|-
|eventTime
|double
|Time of the event
|}
==Uses==
This event is a notification only event, none of the data returned can be changed.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eGetWorldEvent

2007-11-30T20:44:07Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eGetWorldEvent''' is an API event that is called when the world is defined. ==Data== '''bz_eGetWorldEvent''' returns the '''bz...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eGetWorldEvent''' is an API event that is called when the world is defined.

==Data==
'''bz_eGetWorldEvent''' returns the '''bz_GetWorldEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGetWorldEvent
|-
|generated
|bool
|Set to true if the world is generated (ie, not literally loaded from a file)
|-
|ctf
|bool
|Set to true if the game is a [[CTF]]-type game
|-
|rabit
|bool
|Set to true if the game is a [[Rabbit]]-type game
|-
|openFFA
|bool
|Set to true if the game is a [[Free for all]]-type game
|-
|worldFile
|bz_ApiString
|Path to the world file, set to "" (empty string) if not used
|-
|eventTime
|double
|Time of the event
|}
==Uses==
This event is a notification only event, none of the data returned can be changed.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eTickEvent

2007-11-30T20:23:28Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eTickevent''' is an API event that is called each time a tick has occurred . ==Data== '''bz_eTickEvent''' returns the '''bz_Ti...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eTickevent''' is an API event that is called each time a tick has occurred .

==Data==
'''bz_eTickEvent''' returns the '''bz_TickEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eTickEvent
|-
|eventTime
|double
|Time of the event
|}

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

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eGetAutoTeamEvent

2007-11-28T16:46:10Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eGetAutoTeamEvent''' is an API event that is called when the server needs to know which team to add a new player to. ==Data== ...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eGetAutoTeamEvent''' is an API event that is called when the server needs to know which team to add a new player to.

==Data==
'''bz_eGetAutoTeamEvent''' returns the '''bz_GetAutoTeamEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGetAutoTeamEvent
|-
|playerID
|int
|ID of the new player
|-
|callsign
|bzApiString
|Callsign of the new player
|-
|team
|bz_eTeamType
|The team bzfs chose the player to belong to, you CAN change this
|-
|handled
|bool
|Set this value to true once you've modified the team, so that other plugins will know they shouldn't modify it again
|}

==Uses==
You can use this event to let team choosing be done by a plugin.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eGetPlayerSpawnPosEvent

2007-11-28T16:39:08Z

Tulcod:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eGetPlayerSpawnPosEvent''' is an API event that you can use to get and modify a spawn location and is sent just before spawning a player.

==Data==
'''bz_eGetPlayerSpawnPosEvent''' returns the '''bz_GetPlayerSpawnPosEventData''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGetPlayerSpawnPosEventData
|-
|playerID
|int
|ID of the player
|-
|team
|bz_eTeamType
|The team the player belongs to
|-
|handled
|bool
|Set this flag to true once you're done modifying the spawn position, so that other plugins will know whether they can edit the spawn position again
|-
|pos
|float[3]
|Position where the player will be spawned
|-
|rot
|float
|Rotation with which the player will be spawned
|-
|time
|double
|Time at which this event was sent
|}

==Uses==
You can use this event to modify a player's spawn location

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eGetPlayerSpawnPosEvent

2007-11-28T16:37:34Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eGetPlayerSpawnPosEvent''' is an API event that you can use to get and modify a spawn location and is sent just before spawning...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eGetPlayerSpawnPosEvent''' is an API event that you can use to get and modify a spawn location and is sent just before spawning a player.

==Data==
'''bz_eGetPlayerSpawnPosEvent''' returns the '''bz_GetPlayerSpawnPosEventData''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGetPlayerSpawnPosEventData
|-
|playerID
|int
|ID of the player
|-
|team
|bz_eTeamType
|The team the player belongs to
|-
|handled
|bool
|Set this flag to true once you're done modifying the spawn position
|-
|pos
|float[3]
|Position where the player will be spawned
|-
|rot
|float
|Rotation with which the player will be spawned
|-
|time
|double
|Time at which this event was sent
|}

==Uses==
You can use this event to modify a player's spawn location

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eUnknownSlashCommand

2007-11-28T16:08:42Z

Tulcod:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eUnknownSlashCommand''' is an API event that is called each time a "[[slash command]]" (like /help) is received which [[bzfs]] cannot handle.

==Data==
'''bz_eUnknownSlashCommand''' returns the '''bz_UnknownSlashCommandEventData''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eUnknownSlashCommandEvent
|-
|from
|int
|The player who sent the slash command
|-
|handled
|bool
|???
|-
|message
|bzApiString
|The slash command itself
|-
|time
|double
|The time at which the slash command was sent
|}

==Uses==
This event is a notification only event, none of the data returned can be changed. Use this class to interprete slash commands.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eUnknownSlashCommand

2007-11-28T16:08:25Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eUnknownSlashCommand''' is an API event that is called each time a "slash command" (like /help) is received which bzfs ...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eUnknownSlashCommand''' is an API event that is called each time a "[[slash command]]" (like /help) is received which [[bzfs]] cannot handle.

==Data==
'''bz_eUnknownSlashCommand''' returns the '''bz_UnknownSlashCommandEventData''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eUnknownSlashCommandEvent
|-
|from
|int
|The player who sent the slash command
|-
|handled
|bool
|???
bzApiString message;

double time;
|-
|message
|bzApiString
|The slash command itself
|-
|time
|double
|The time at which the slash command was sent
|}

==Uses==
This event is a notification only event, none of the data returned can be changed. Use this class to interprete slash commands.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eFilteredChatMessageEvent

2007-11-28T16:00:18Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} {{Stub}} ==Overview== The '''bz_eFilteredChatMessageEvent''' is an API event that is called each time a filtered chat message is received. ==Data== '...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}
{{Stub}}

==Overview==
The '''bz_eFilteredChatMessageEvent''' is an API event that is called each time a filtered chat message is received.

==Data==
'''bz_eFilteredChatMessageEvent''' returns the '''<!>''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eFilteredChatMessageEvent
|-
|<!>
|<!>
|<!>
|}

==Uses==
<!>

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eRawChatMessageEvent

2007-11-28T15:58:39Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} {{Stub}} ==Overview== The '''bz_eRawChatMessageEvent''' is an API event that is called each time a raw chat message is received. ==Data== '''bz_eRawC...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}
{{Stub}}

==Overview==
The '''bz_eRawChatMessageEvent''' is an API event that is called each time a raw chat message is received.

==Data==
'''bz_eRawChatMessageEvent''' returns the '''<!>''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eRawChatMessageEvent
|-
|<!>
|<!>
|<!>
|}

==Uses==
<!>

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eZoneExitEvent

2007-11-28T15:56:12Z

Tulcod:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}
{{Stub}}

==Overview==
The '''bz_eZoneExitEvent''' is an API event that is called each time a player leaves a [[zone]] on a [[BZW]] map.

==Data==
'''bz_eZoneExitEvent''' returns the '''<!>''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eZoneExitEvent
|-
|<!>
|<!>
|<!>
|}

==Uses==
This event is a notification only event, none of the data returned can be changed. <!>

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eZoneEntryEvent

2007-11-28T15:55:50Z

Tulcod:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}
{{Stub}}
==Overview==
The '''bz_eZoneEntryEvent''' is an API event that is called each time a player enters a [[zone]] on a [[BZW]] map.

==Data==
'''bz_eZoneEntryEvent''' returns the '''<!>''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eZoneEntryEvent
|-
|<!>
|<!>
|<!>
|}

==Uses==
This event is a notification only event, none of the data returned can be changed. <!>

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz ePlayerSpawnEvent

2007-11-28T15:55:31Z

Tulcod:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==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.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|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.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz ePlayerDieEvent

2007-11-28T15:55:16Z

Tulcod:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerDieEvent''' is an API event that is called each time a player died.

==Data==
'''bz_ePlayerDieEvent''' returns the '''bz_PlayerDieEventData''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerDieEvent
|-
|playerID
|int
|ID of the player who died
|-
|team
|bz_eTeamType
|The team the dying player was a member of
|-
|killerID
|int
|The bastard who killed the player
|-
|killerTeam
|bz_eTeamType
|The team the killer was a member of
|-
|flagKilledWith
|bzApiString
|The kind of flag used to kill
|-
|shotID
|int
|Index of the bullet which hit the player fatally
|-
|pos
|float[3]
|Position of the dying player
|-
|rot
|float
|Rotation of the dying player
|-
|time
|double
|Time at which the player was killed
|}

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

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eCaptureEvent

2007-11-28T15:54:56Z

Tulcod:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eCaptureEvent''' is an API event that is called each time a team's flag has been captured.

==Data==
'''bz_eCaptureEvent''' returns the '''bz_CTFCaptureEventData''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eCaptureEvent
|-
|teamCapped
|[[bz_eTeamType]]
|The team whose flag has been captured
|-
|teamCapping
|[[bz_eTeamType]]
|The team who has captured a flag
|-
|playerCapping
|int
|The player who captured the flag
|-
|pos
|float[3]
|Position where the flag has been captured
|-
|rot
|float
|Rotation of the capturing player
|-
|time
|double
|The time on which the flag was captured
|}
==Uses==
This event is a notification only event, none of the data returned can be changed.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz ePlayerPartEvent

2007-11-28T15:51:50Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_ePlayerPartEvent''' is an API event that is called each time a player parts (ie, leaves) a game. ==Data== '''bz_ePlayerPartEve...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerPartEvent''' is an API event that is called each time a player parts (ie, leaves) a game.

==Data==
'''bz_ePlayerPartEvent''' returns the '''bz_PlayerJoinPartEventData_V1''' data class.
The event data record is shared between both join and part events.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerPartEvent
|-
|playerID
|int
|The player ID that is leaving
|-
|record
|[[bz_BasePlayerRecord]] *
|The player record for the leaving player
|-
|reason
|bzApiString
|The reason for the event, for example, why a player has been kicked
|-
|eventTime
|double
|Time of event.
|}

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

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eZoneExitEvent

2007-11-28T15:48:56Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} {{Stub}} ==Overview== The '''bz_eZoneExitEvent''' is an API event that is called each time a player leaves a zone on a BZW map. ==Data== '''b...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}
{{Stub}}

==Overview==
The '''bz_eZoneExitEvent''' is an API event that is called each time a player leaves a [[zone]] on a [[BZW]] map.

==Data==
'''bz_eZoneExitEvent''' returns the '''<!>''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|<!>
|<!>
|<!>
|}

==Uses==
This event is a notification only event, none of the data returned can be changed. <!>

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eZoneEntryEvent

2007-11-28T15:48:02Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} {{Stub}} ==Overview== The '''bz_eZoneEntryEvent''' is an API event that is called each time a player enters a zone on a BZW map. ==Data== '''b...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}
{{Stub}}
==Overview==
The '''bz_eZoneEntryEvent''' is an API event that is called each time a player enters a [[zone]] on a [[BZW]] map.

==Data==
'''bz_eZoneEntryEvent''' returns the '''<!>''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|<!>
|<!>
|<!>
|}

==Uses==
This event is a notification only event, none of the data returned can be changed. <!>

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz ePlayerSpawnEvent

2007-11-28T15:31:54Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==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...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==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.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|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.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz ePlayerDieEvent

2007-11-28T15:27:42Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_ePlayerDieEvent''' is an API event that is called each time a player died. ==Data== '''bz_ePlayerDieEvent''' returns the '''bz...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerDieEvent''' is an API event that is called each time a player died.

==Data==
'''bz_ePlayerDieEvent''' returns the '''bz_PlayerDieEventData''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|playerID
|int
|ID of the player who died
|-
|team
|bz_eTeamType
|The team the dying player was a member of
|-
|killerID
|int
|The bastard who killed the player
|-
|killerTeam
|bz_eTeamType
|The team the killer was a member of
|-
|flagKilledWith
|bzApiString
|The kind of flag used to kill
|-
|shotID
|int
|Index of the bullet which hit the player fatally
|-
|pos
|float[3]
|Position of the dying player
|-
|rot
|float
|Rotation of the dying player
|-
|time
|double
|Time at which the player was killed
|}

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

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eCaptureEvent

2007-11-28T15:13:27Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eCaptureEvent''' is an API event that is called each time a team's flag has been captured. ==Data== '''bz_eCaptureEvent''' ret...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eCaptureEvent''' is an API event that is called each time a team's flag has been captured.

==Data==
'''bz_eCaptureEvent''' returns the '''bz_CTFCaptureEventData''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|teamCapped
|[[bz_eTeamType]]
|The team whose flag has been captured
|-
|teamCapping
|[[bz_eTeamType]]
|The team who has captured a flag
|-
|playerCapping
|int
|The player who captured the flag
|-
|pos
|float[3]
|Position where the flag has been captured
|-
|rot
|float
|Rotation of the capturing player
|-
|time
|double
|The time on which the flag was captured
|}
==Uses==
This event is a notification only event, none of the data returned can be changed.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz eNullEvent

2007-11-28T15:09:29Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eNullEvent''' is an empty API event not being used for any action. It's the default value of all event data. ==Data== '''bz_eN...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eNullEvent''' is an empty API event not being used for any action. It's the default value of all event data.

==Data==
'''bz_eNullEvent''' returns the '''bz_EventData''' data class.
Other EventData classes are derived from this class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|bz_eEventType
|The type of event. Defaults to bz_eNullEvent.
|}

==Uses==
You should not use this class.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz ePlayerJoinEvent

2007-11-27T21:43:39Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_ePlayerJoinEvent''' is an API event that is called each time a player joins the game. ==Data== '''bz_ePlayerJoinEvent''' retur...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerJoinEvent''' is an API event that is called each time a player joins the game.

==Data==
'''bz_ePlayerJoinEvent''' returns the '''bz_PlayerJoinPartEventData''' data class.
int playerID;
bz_eTeamType team;

bzApiString callsign;
bzApiString email;
bool verified;
bzApiString globalUser;
bzApiString ipAddress;
bzApiString reason;

double time;
{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value desription
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eFlagDroppedEvent
|-
|playerID
|int
|The player that dropped the flag
|-
|team
|bz_eTeamType
|The team the new player is a member of
|-
|callsign
|bzApiString
|Callsign of the player
|-
|email
|bzApiString
|Email string of the player
|-
|verified
|bool
|This flag is true if a player has identified as a registered user.
|-
|globalUser
|bzApiString
|Registered username of the player
|-
|ipAddress
|bzApiString
|IP address of the player
|-
|reason
|bzApiString
|Not used for join events
|-
|time
|double
|Time of join
|}

==Uses==
This data can be used to make a database of users, for example if you have a special statistics system.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Bz sendTextMessage

2007-11-27T21:34:19Z

Tulcod:

{{BZFS_API_Doc}}
{{BZFS_API_Funcs}}
==Prototype==
BZF_API bool bz_sendTextMessage (int from, int to, const char* message);
BZF_API bool bz_sendTextMessage (int from, bz_eTeamType to, const char* message);

==Parameters==
* int from: From which player do we need to pretend this message is coming from?
* int to: To which player or team are we sending this message?
* const char* message: The message to be sent

==Description==
This API function will cause the server to send a message to a player or team

==Usage==
If you want to send a message, use this function. This can be used for private messages based on previous input.

==Notes==
Want to send a message coming from the server, and not pretend to be someone else? Use BZ_SERVER for the from argument.

Bz sendTextMessage

2007-11-27T21:31:13Z

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Funcs}} ==Prototype== BZF_API bool bz_sendTextMessage (int from, int to, const char* message); BZF_API bool bz_sendTextMessage (int from, bz_eTeamType to, const...