zscript-doc/api/player/PlayerClass.md

44 lines
666 B
Markdown
Raw Permalink Normal View History

2018-12-29 16:05:19 -08:00
# PlayerClass
A player class as defined in either `MAPINFO`/GameInfo or `KEYCONF`.
```
struct PlayerClass
{
2019-08-14 03:32:51 -07:00
uint Flags;
array<int> Skins;
class<Actor> Type;
2018-12-29 16:05:19 -08:00
2019-08-14 03:32:51 -07:00
bool CheckSkin(int skin);
void EnumColorsets(out array<int> data);
name GetColorsetName(int setnum);
2018-12-29 16:05:19 -08:00
}
```
2019-08-14 03:31:41 -07:00
### `Flags`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Not currently implemented correctly, `PCF_NOMENU` does not exist in ZScript,
but its value is `1` if you need to check for that.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Skins`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Skin indices available to this player class.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Type`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The class type reference for this player class.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `CheckSkin`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Checks if `skin` is in `Skins`.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `EnumColorsets`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
TODO
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `GetColorsetName`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
TODO
2018-12-29 16:05:19 -08:00
<!-- EOF -->