Bz eGetWorldEvent - Revision history

Zehra: redirect, since events are in official docs

2025-11-27T02:07:45Z

redirect, since events are in official docs

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

	~~==Overview==~~
	~~The '''bz_eGetWorldEvent''' is an API event that is called before the~~ [[BZFS~~]] server defines the world.~~

	~~==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~~
	\|The value representing the state of the world generation. If another plug-in has generated a world, this value will be set to true. If the plug-in processing this event, adds world geometry using the '''bz_addWorld''' methods ([[bz_addWorldBox]], [[bz_addWorldPyramid]] etc. ) then it must set this value to true.
	\|-
	~~\|ctf~~
	~~\|bool~~
	~~\|This value represents the game state being a Capture the Flag (CTF) type game. Mutually exclusive with other game type setings.~~
	\|-
	~~\|rabbit~~
	~~\|bool~~
	~~\|This value represents the game state being a Rabbit Hunt type game. Mutually exclusive with other game type setings.~~
	\|-
	~~\|openFFA~~
	~~\|bool~~
	~~\|This value represents the game state being a [[Free For All]] type game. Mutually exclusive with other game type setings.~~
	\|-
	~~\|worldBlob~~
	\|char*
	~~\|A pointer to a memory location from which to read the world stream. Overrides worldFile.~~
	\|-
	~~\|worldFile~~
	~~\|[[bz_ApiString]]~~
	~~\|The path to the map file that will be used when this event is completed. If the string is zero length, then either a plug-in defined map or a random map will be used.~~
	\|-
	~~\|eventTime~~
	~~\|double~~
	~~\|Local Server time of the event.~~
	\|}

	~~==Uses==~~
	~~This event is a modification event. It is the primary hook for plug-ins that wish to modify the world. The available options are;~~

	~~===Map file override ===~~
	~~If the plug-in wishes to force the server to use a specific map file, it can set the '''worldFile''' member. This member may be set to any valid local path or an http:// or ftp:// URL.~~

	The plug-in may instead use the worldFile member for information only, and write a valid BZW world into a contiguous memory location with a 0 terminating character, passing that pointer back to BZFS via the worldBlob member. It is the caller's responsibility to free this memory; this may be done in the [[bz_eWorldFinalized]] ~~event.~~

	~~===Game Style overide===~~
	~~The plug-in may change the game style flags to override the initial game mode.~~

71.7.238.37: /* Map file override */

2009-01-27T01:39:40Z

Map file override

← Older revision		Revision as of 01:39, 27 January 2009
Line 52:		Line 52:
	If the plug-in wishes to force the server to use a specific map file, it can set the '''worldFile''' member. This member may be set to any valid local path or an http:// or ftp:// URL.		If the plug-in wishes to force the server to use a specific map file, it can set the '''worldFile''' member. This member may be set to any valid local path or an http:// or ftp:// URL.

	The plug-in may instead use the worldFile member for information only, and write a valid BZW world into a contiguous memory location, passing that pointer back to BZFS via the worldBlob member. It is the caller's responsibility to free this memory; this may be done in the [[bz_eWorldFinalized]] event.		The plug-in may instead use the worldFile member for information only, and write a valid BZW world into a contiguous memory location with a 0 terminating character, passing that pointer back to BZFS via the worldBlob member. It is the caller's responsibility to free this memory; this may be done in the [[bz_eWorldFinalized]] event.

	===Game Style overide===		===Game Style overide===
	The plug-in may change the game style flags to override the initial game mode.		The plug-in may change the game style flags to override the initial game mode.

JeffM2501: /* Plug-in defined maps */

2008-04-14T17:03:46Z

Plug-in defined maps

← Older revision		Revision as of 17:03, 14 April 2008
Line 56:		Line 56:
	===Game Style overide===		===Game Style overide===
	The plug-in may change the game style flags to override the initial game mode.		The plug-in may change the game style flags to override the initial game mode.

	~~===Plug-in defined maps===~~
	If the plug-in sets the '''worldFile''' member to a zero length string, it can then make any number of calls to the world definition functions to define a map file programaticly. These functions include;

	* [[bz_addWorldBox]]
	* [[bz_addWorldPyramid]]
	* [[bz_addWorldBase]]
	* [[bz_addWorldTeleporter]]
	* [[bz_addWorldWaterLevel]]
	* [[bz_addWorldWeapon]]
	* [[bz_setWorldSize]]

DTRemenak: /* Map file override */ details on worldFile

2008-03-30T02:01:36Z

Map file override: details on worldFile

← Older revision		Revision as of 02:01, 30 March 2008
Line 50:		Line 50:

	===Map file override ===		===Map file override ===
	If the plug-in wishes to force the server to use a specific map file, it can set the '''worldFile''' member.		If the plug-in wishes to force the server to use a specific map file, it can set the '''worldFile''' member. This member may be set to any valid local path or an http:// or ftp:// URL.

	The plug-in may instead use the worldFile member for information only, and write a valid BZW world into a contiguous memory location, passing that pointer back to BZFS via the worldBlob member. It is the caller's responsibility to free this memory; this may be done in the [[bz_eWorldFinalized]] event.		The plug-in may instead use the worldFile member for information only, and write a valid BZW world into a contiguous memory location, passing that pointer back to BZFS via the worldBlob member. It is the caller's responsibility to free this memory; this may be done in the [[bz_eWorldFinalized]] event.

DTRemenak: /* Map file overide */ doc worldBlob

2008-03-30T01:59:47Z

Map file overide: doc worldBlob

← Older revision		Revision as of 01:59, 30 March 2008
Line 49:		Line 49:
	This event is a modification event. It is the primary hook for plug-ins that wish to modify the world. The available options are;		This event is a modification event. It is the primary hook for plug-ins that wish to modify the world. The available options are;

	===Map file ~~overide~~ ===		===Map file override ===
	If the plug-in wishes to force the server to use a specific map file, it can set the '''worldFile''' member.		If the plug-in wishes to force the server to use a specific map file, it can set the '''worldFile''' member.

			The plug-in may instead use the worldFile member for information only, and write a valid BZW world into a contiguous memory location, passing that pointer back to BZFS via the worldBlob member. It is the caller's responsibility to free this memory; this may be done in the [[bz_eWorldFinalized]] event.

	===Game Style overide===		===Game Style overide===

DTRemenak: /* Data */ doc worldBlob

2008-03-30T01:57:30Z

Data: doc worldBlob

← Older revision		Revision as of 01:57, 30 March 2008
Line 25:		Line 25:
	\|This value represents the game state being a Capture the Flag (CTF) type game. Mutually exclusive with other game type setings.		\|This value represents the game state being a Capture the Flag (CTF) type game. Mutually exclusive with other game type setings.
	\|-		\|-
	\|~~rabit~~		\|rabbit
	\|bool		\|bool
	\|This value represents the game state being a Rabbit Hunt type game.Mutually exclusive with other game type setings.		\|This value represents the game state being a Rabbit Hunt type game. Mutually exclusive with other game type setings.
	\|-		\|-
	\|openFFA		\|openFFA
	\|bool		\|bool
	\|This value represents the game state being a [[Free For All]] type game.Mutually exclusive with other game type setings.		\|This value represents the game state being a [[Free For All]] type game. Mutually exclusive with other game type setings.
			\|-
			\|worldBlob
			\|char*
			\|A pointer to a memory location from which to read the world stream. Overrides worldFile.
	\|-		\|-
	\|worldFile		\|worldFile
	\|[[bz_ApiString]]		\|[[bz_ApiString]]
	\|The path to the map file that will be used when this event is completed. If the string is zero ~~lenght~~, then ~~ether~~ a plug-in defined map or a random map will be used.		\|The path to the map file that will be used when this event is completed. If the string is zero length, then either a plug-in defined map or a random map will be used.
	\|-		\|-
	\|eventTime		\|eventTime
Line 41:		Line 45:
	\|Local Server time of the event.		\|Local Server time of the event.
	\|}		\|}

	==Uses==		==Uses==
	This event is a modification event. It is the primary hook for plug-ins that wish to modify the world. The available options are;		This event is a modification event. It is the primary hook for plug-ins that wish to modify the world. The available options are;

JeffM2501 at 21:27, 30 November 2007

2007-11-30T21:27:14Z

← Older revision		Revision as of 21:27, 30 November 2007
Line 3:		Line 3:

	==Overview==		==Overview==
	The '''bz_eGetWorldEvent''' is an API event that is called ~~when~~ the world ~~is defined~~.		The '''bz_eGetWorldEvent''' is an API event that is called before the [[BZFS]] server defines the world.

	==Data==		==Data==
Line 19:		Line 19:
	\|generated		\|generated
	\|bool		\|bool
	\|~~Set~~ to true if the world ~~is generated~~ (ie, ~~not literally loaded from a file~~)		\|The value representing the state of the world generation. If another plug-in has generated a world, this value will be set to true. If the plug-in processing this event, adds world geometry using the '''bz_addWorld''' methods ([[bz_addWorldBox]], [[bz_addWorldPyramid]] etc. ) then it must set this value to true.
	\|-		\|-
	\|ctf		\|ctf
	\|bool		\|bool
	\|~~Set to true if~~ the game is a [[CTF~~]]-~~type game		\|This value represents the game state being a Capture the Flag (CTF) type game. Mutually exclusive with other game type setings.
	\|-		\|-
	\|rabit		\|rabit
	\|bool		\|bool
	\|~~Set to true if~~ the game is a [[Rabbit Hunt~~]]-~~type game		\|This value represents the game state being a Rabbit Hunt type game.Mutually exclusive with other game type setings.
	\|-		\|-
	\|openFFA		\|openFFA
	\|bool		\|bool
	\|~~Set to true if~~ the game is a [[Free For All]]-type game		\|This value represents the game state being a [[Free For All]] type game.Mutually exclusive with other game type setings.
	\|-		\|-
	\|worldFile		\|worldFile
	\|[[bz_ApiString]]		\|[[bz_ApiString]]
	\|~~Path~~ to the ~~world~~ file, ~~set to "" (empty string) if not~~ used		\|The path to the map file that will be used when this event is completed. If the string is zero lenght, then ether a plug-in defined map or a random map will be used.
	\|-		\|-
	\|eventTime		\|eventTime
	\|double		\|double
	\|~~Time~~ of the event		\|Local Server time of the event.
	\|}		\|}
	==Uses==		==Uses==
	This event is a ~~notification only~~ event~~, none of~~ the ~~data returned can be changed~~.		This event is a modification event. It is the primary hook for plug-ins that wish to modify the world. The available options are;

	[[~~Category:BZFS_API_Docs~~]]		===Map file overide ===
	[[~~Category:BZFS_API_Events~~]]		If the plug-in wishes to force the server to use a specific map file, it can set the '''worldFile''' member.

			===Game Style overide===
			The plug-in may change the game style flags to override the initial game mode.

			===Plug-in defined maps===
			If the plug-in sets the '''worldFile''' member to a zero length string, it can then make any number of calls to the world definition functions to define a map file programaticly. These functions include;

			* [[bz_addWorldBox]]
			* [[bz_addWorldPyramid]]
			* [[bz_addWorldBase]]
			* [[bz_addWorldTeleporter]]
			* [[bz_addWorldWaterLevel]]
			* [[bz_addWorldWeapon]]
			* [[bz_setWorldSize]]

Tulcod at 20:45, 30 November 2007

2007-11-30T20:45:43Z

← Older revision		Revision as of 20:45, 30 November 2007
Line 34:		Line 34:
	\|-		\|-
	\|worldFile		\|worldFile
	\|bz_ApiString		\|[[bz_ApiString]]
	\|Path to the world file, set to "" (empty string) if not used		\|Path to the world file, set to "" (empty string) if not used
	\|-		\|-

Tulcod at 20:45, 30 November 2007

2007-11-30T20:45:11Z

← Older revision		Revision as of 20:45, 30 November 2007
Line 27:		Line 27:
	\|rabit		\|rabit
	\|bool		\|bool
	\|Set to true if the game is a [[Rabbit]]-type game		\|Set to true if the game is a [[Rabbit Hunt]]-type game
	\|-		\|-
	\|openFFA		\|openFFA
	\|bool		\|bool
	\|Set to true if the game is a [[Free ~~for all~~]]-type game		\|Set to true if the game is a [[Free For All]]-type game
	\|-		\|-
	\|worldFile		\|worldFile

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

2007-11-30T20:44:07Z

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

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