This wiki is archived and useful information is being migrated to the main bzflag.org website
Editing Bz eGetWorldEvent
Warning: The database has been locked for maintenance, so you will not be able to save your edits right now. You may wish to copy and paste your text into a text file and save it for later.
The administrator who locked it offered this explanation: Archived wiki
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 3: | Line 3: | ||
==Overview== | ==Overview== | ||
− | The '''bz_eGetWorldEvent''' is an API event that is called | + | The '''bz_eGetWorldEvent''' is an API event that is called when the world is defined. |
==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) |
|- | |- | ||
|ctf | |ctf | ||
|bool | |bool | ||
− | | | + | |Set to true if the game is a [[CTF]]-type game |
|- | |- | ||
− | | | + | |rabit |
|bool | |bool | ||
− | | | + | |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 |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|- | |- | ||
|worldFile | |worldFile | ||
|[[bz_ApiString]] | |[[bz_ApiString]] | ||
− | | | + | |Path to the world file, set to "" (empty string) if not used |
|- | |- | ||
|eventTime | |eventTime | ||
|double | |double | ||
− | | | + | |Time of the event |
|} | |} | ||
− | |||
==Uses== | ==Uses== | ||
− | This event is a | + | This event is a notification only event, none of the data returned can be changed. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | [[Category:BZFS_API_Docs]] | |
− | + | [[Category:BZFS_API_Events]] |