zscript-doc/api/inter/WBStartStruct.md

97 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2018-12-29 16:05:19 -08:00
# WBStartStruct
Information passed into the `StatusScreen` class when an intermission starts.
```
struct WBStartStruct
{
2019-08-14 03:32:51 -07:00
WBPlayerStruct Plyr[MAXPLAYERS];
int PNum;
2018-12-29 16:05:19 -08:00
2019-08-14 03:32:51 -07:00
int Finished_Ep;
int Next_Ep;
2018-12-29 16:05:19 -08:00
2019-08-14 03:32:51 -07:00
string Current;
string Next;
string NextName;
2018-12-29 16:05:19 -08:00
2019-08-14 03:32:51 -07:00
textureid LName0;
textureid LName1;
2018-12-29 16:05:19 -08:00
2019-08-14 03:32:51 -07:00
int MaxFrags;
int MaxItems;
int MaxKills;
int MaxSecret;
2018-12-29 16:05:19 -08:00
2019-08-14 03:32:51 -07:00
int ParTime;
int SuckTime;
int TotalTime;
2018-12-29 16:05:19 -08:00
}
```
2019-08-14 03:31:41 -07:00
### `Plyr`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The `WBPlayerStruct` for each player.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `PNum`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The index of the player to show stats for.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Finished_Ep`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The cluster of the finished map, minus one.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Next_Ep`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The cluster of the next map, minus one.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Current`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The name of the map that was finished.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Next`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The name of the next map.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `NextName`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The printable name of the next map.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `LName0`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Texture ID of the level name of the map that was finished.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `LName1`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Texture ID of the level name of the map being entered.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `MaxFrags`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Unknown purpose, not actually used by any part of the engine.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `MaxItems`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The maximum number of acquired items in the map.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `MaxKills`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The maximum number of killed monsters in the map.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `MaxSecret`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The maximum number of found secrets in the map.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `ParTime`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The par time of the map, in ticks.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `SuckTime`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The suck time of the map, in minutes.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `TotalTime`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The total time for the whole game, in ticks.
2018-12-29 16:05:19 -08:00
<!-- EOF -->