This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.

Bz eGetWorldEvent: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
Tulcod (talk | contribs)
28 edits
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...
 
Zehra (talk | contribs)
988 edits
redirect, since events are in official docs
Tag: New redirect
 
(8 intermediate revisions by 4 users not shown)
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 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]]

Latest revision as of 02:07, 27 November 2025

Redirect to:

Retrieved from "https://wiki.bzflag.org/index.php?title=Bz_eGetWorldEvent&oldid=9987"