Bz eGetPlayerSpawnPosEvent - Revision history

Zehra: redirect, since events are in official docs

2025-11-09T22:37:12Z

redirect, since events are in official docs

← Older revision		Revision as of 22:37, 9 November 2025
Line 1:		Line 1:
	~~{{BZFS_API_Doc}}~~		#REDIRECT [[Category:BZFS API Docs]]
	~~{{BZFS_API_Events}}~~

	~~==Overview==~~
	~~The '''bz_eGetPlayerSpawnPosEvent''' is an API event that is called each time the server needs a new spawn position.~~

	~~==Data==~~
	~~'''bz_eGetPlayerSpawnPosEvent''' returns the '''bz_GetPlayerSpawnPosEventData_V1''' 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 that is requesting the spawn position.~~
	\|-
	~~\|team~~
	~~\|bz_eTeamType~~
	~~\|The team the player is currently in.~~
	\|-
	~~\|handled~~
	~~\|bool~~
	\|The current state representing if other plug-ins have modified the spawn position. Plug-ins that modify the spawn position should set this value to true to inform other plug-ins that have not processed yet.
	\|-
	~~\|pos~~
	~~\|float[3]~~
	~~\|Position where the player will be spawned. This value is initialized to the server computed spawn position using the current spawn rules.~~
	\|-
	~~\|rot~~
	~~\|float~~
	~~\|The rotational direction that the player will be spawned at. This value is initialized to the server computed spawn rotation using the current spawn rules.~~
	\|-
	~~\|eventTime~~
	~~\|double~~
	~~\|The server time at which the event occurred (in seconds).~~
	\|}

	~~==Uses==~~
	~~This is a modification event, plug-ins may change the pos and rot fields to effect changes in the spawn position that is used for the player.~~

Alezakos: fix typo

2014-09-08T21:38:25Z

fix typo

← Older revision		Revision as of 21:38, 8 September 2014
Line 3:		Line 3:

	==Overview==		==Overview==
	The '''bz_eGetPlayerSpawnPosEvent''' is an API event that is called each time the server needs a new spawn ~~postion~~.		The '''bz_eGetPlayerSpawnPosEvent''' is an API event that is called each time the server needs a new spawn position.

	==Data==		==Data==

Allejo: changed time to eventTime

2014-05-01T07:48:32Z

changed time to eventTime

← Older revision		Revision as of 07:48, 1 May 2014
Line 37:		Line 37:
	\|The rotational direction that the player will be spawned at. This value is initialized to the server computed spawn rotation using the current spawn rules.		\|The rotational direction that the player will be spawned at. This value is initialized to the server computed spawn rotation using the current spawn rules.
	\|-		\|-
	\|~~time~~		\|eventTime
	\|double		\|double
	\|The ~~local~~ server time of the event.		\|The server time at which the event occurred (in seconds).
	\|}		\|}

	==Uses==		==Uses==
	This is a modification event, plug-ins may change the pos and rot fields to effect changes in the spawn position that is used for the player.		This is a modification event, plug-ins may change the pos and rot fields to effect changes in the spawn position that is used for the player.

JeffM2501 at 17:59, 28 November 2007

2007-11-28T17:59:16Z

← Older revision		Revision as of 17:59, 28 November 2007
Line 3:		Line 3:

	==Overview==		==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~~.		The '''bz_eGetPlayerSpawnPosEvent''' is an API event that is called each time the server needs a new spawn postion.

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

	{\| border="1" cellpadding="20" cellspacing="0"		{\| border="1" cellpadding="20" cellspacing="0"
Line 19:		Line 19:
	\|playerID		\|playerID
	\|int		\|int
	\|ID of the player		\|ID of the player that is requesting the spawn position.
	\|-		\|-
	\|team		\|team
	\|bz_eTeamType		\|bz_eTeamType
	\|The team the player ~~belongs to~~		\|The team the player is currently in.
	\|-		\|-
	\|handled		\|handled
	\|bool		\|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~~		\|The current state representing if other plug-ins have modified the spawn position. Plug-ins that modify the spawn position should set this value to true to inform other plug-ins that have not processed yet.
	\|-		\|-
	\|pos		\|pos
	\|float[3]		\|float[3]
	\|Position where the player will be spawned		\|Position where the player will be spawned. This value is initialized to the server computed spawn position using the current spawn rules.
	\|-		\|-
	\|rot		\|rot
	\|float		\|float
	\|~~Rotation with which~~ the player will be spawned		\|The rotational direction that the player will be spawned at. This value is initialized to the server computed spawn rotation using the current spawn rules.
	\|-		\|-
	\|time		\|time
	\|double		\|double
	\|~~Time at which this~~ event ~~was sent~~		\|The local server time of the event.
	\|}		\|}

	==Uses==		==Uses==
	~~You can use this~~ event to ~~modify a~~ player~~'s spawn location~~		This is a modification event, plug-ins may change the pos and rot fields to effect changes in the spawn position that is used for the player.

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

Tulcod at 16:39, 28 November 2007

2007-11-28T16:39:08Z

← Older revision		Revision as of 16:39, 28 November 2007
Line 27:		Line 27:
	\|handled		\|handled
	\|bool		\|bool
	\|Set this flag to true once you're done modifying the spawn position		\|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		\|pos

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

2007-11-28T16:37:34Z

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

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