Bz ePlayerJoinEvent - Revision history

Zehra: redirect, since events are in official docs

2025-11-09T22:39:22Z

redirect, since events are in official docs

← Older revision		Revision as of 22:39, 9 November 2025
Line 1:		Line 1:
	~~{{BZFS_API_Doc}}~~		#REDIRECT [[Category:BZFS API Docs]]
	~~{{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_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_ePlayerJoinEvent~~
	\|-
	~~\|playerID~~
	~~\|int~~
	~~\|The player ID that is joining~~
	\|-
	~~\|record~~
	\|[[bz_BasePlayerRecord]] *
	~~\|The player record for the joining player~~
	\|-
	~~\|reason~~
	~~\|[[bz_ApiString~~]]
	~~\|The reason for the event, unused for join events~~
	\|-
	~~\|eventTime~~
	~~\|double~~
	~~\|Time of event.~~
	\|}

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

Khonkhortisan: /* Uses */ hyphenated compound adjective

2013-01-27T23:30:31Z

Uses: hyphenated compound adjective

← Older revision		Revision as of 23:30, 27 January 2013
Line 36:		Line 36:

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

JeffM2501 at 17:29, 28 November 2007

2007-11-28T17:29:31Z

← Older revision		Revision as of 17:29, 28 November 2007
Line 27:		Line 27:
	\|-		\|-
	\|reason		\|reason
	\|~~bzApiString~~		\|[[bz_ApiString]]
	\|The reason for the event, ~~only used~~ for ~~part~~ events.		\|The reason for the event, unused for join events
	\|-		\|-
	\|eventTime		\|eventTime
Line 37:		Line 37:
	==Uses==		==Uses==
	This event is a notification only event, none of the data returned can be changed.		This event is a notification only event, none of the data returned can be changed.

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

JeffM2501 at 22:27, 27 November 2007

2007-11-27T22:27:31Z

← Older revision		Revision as of 22:27, 27 November 2007
Line 7:		Line 7:
	==Data==		==Data==
	'''bz_ePlayerJoinEvent''' returns the '''bz_PlayerJoinPartEventData_V1''' data class.		'''bz_ePlayerJoinEvent''' 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"		{\| border="1" cellpadding="20" cellspacing="0"
	!name		!name
	!type		!type
	!value ~~desription~~		!value description
	\|-		\|-
	\|eventType		\|eventType
	\|[[Event(API)\|bz_eEventType]]		\|[[Event(API)\|bz_eEventType]]
	\|~~bz_eFlagDroppedEvent~~		\|bz_ePlayerJoinEvent
	\|-		\|-
	\|playerID		\|playerID
	\|int		\|int
	\|The player that ~~dropped the flag~~		\|The player ID that is joining
	\|-		\|-
	\|record		\|record
Line 27:		Line 28:
	\|reason		\|reason
	\|bzApiString		\|bzApiString
	\|~~Not~~ used for ~~join~~ events		\|The reason for the event, only used for part events.
	\|-		\|-
	\|eventTime		\|eventTime

JeffM2501: /* Data */

2007-11-27T21:58:30Z

Data

← Older revision		Revision as of 21:58, 27 November 2007
Line 6:		Line 6:

	==Data==		==Data==
	'''bz_ePlayerJoinEvent''' returns the '''~~bz_PlayerJoinPartEventData~~''' data class.		'''bz_ePlayerJoinEvent''' returns the '''bz_PlayerJoinPartEventData_V1''' data class.

	{\| border="1" cellpadding="20" cellspacing="0"		{\| border="1" cellpadding="20" cellspacing="0"
Line 21:		Line 21:
	\|The player that dropped the flag		\|The player that dropped the flag
	\|-		\|-
	\|~~team~~		\|record
	\|~~bz_eTeamType~~		\|[[bz_BasePlayerRecord]] *
	\|The ~~team the new player is a member of~~		\|The player record for the joining player
	\|-
	~~\|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		\|reason
Line 49:		Line 29:
	\|Not used for join events		\|Not used for join events
	\|-		\|-
	\|~~time~~		\|eventTime
	\|double		\|double
	\|Time of ~~join~~		\|Time of event.
	\|}		\|}

JeffM2501: /* Data */

2007-11-27T21:55:29Z

Data

← Older revision		Revision as of 21:55, 27 November 2007
Line 7:		Line 7:
	==Data==		==Data==
	'''bz_ePlayerJoinEvent''' returns the '''bz_PlayerJoinPartEventData''' data class.		'''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"		{\| border="1" cellpadding="20" cellspacing="0"
	!name		!name

JeffM2501 at 21:54, 27 November 2007

2007-11-27T21:54:04Z

← Older revision		Revision as of 21:54, 27 November 2007
Line 65:		Line 65:

	==Uses==		==Uses==
	This data can be ~~used to make a database of users, for example if you have a special statistics system~~.		This event is a notification only event, none of the data returned can be changed.

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

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

2007-11-27T21:43:39Z

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

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''' 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]]