zscript-doc/api/player/PlayerSkin.md

72 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2018-12-29 16:05:19 -08:00
# PlayerSkin
A player skin as defined in `SKININFO` or `S_SKIN`.
```
struct PlayerSkin
{
2019-08-14 03:32:51 -07:00
int CrouchSprite;
string Face;
uint8 Gender;
int NameSpc;
bool OtherGame;
uint8 Range0End;
uint8 Range0Start;
vector2 Scale;
string SkinName;
int Sprite;
2018-12-29 16:05:19 -08:00
}
```
2019-08-14 03:31:41 -07:00
### `CrouchSprite`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The crouching sprite ID for this skin.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Face`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Prefix for statusbar face graphics.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Gender`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Default gender of the skin. May be one of the following:
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
| Name | Value | Description |
| ---- | :---: | ----------- |
| `GENDER_FEMALE` | `1` | Feminine. |
| `GENDER_MALE` | `0` | Masculine. |
| `GENDER_NEUTRAL` | `2` | Neutral. |
| `GENDER_OTHER` | `3` | Other (robot, zombie, etc.) |
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `NameSpc`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
If this skin was defined in S_SKIN, this is the lump ID of the marker itself.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `OtherGame`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The player skin is made for another game and needs to be color remapped
differently.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Range0End`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The end index of the translation range to be used for changing the player
sprite's color.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Range0Start`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The beginning index of the translation range to be used for changing the player
sprite's color.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Scale`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The scaling factor used for the player sprite.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `SkinName`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Name of the skin.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Sprite`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The sprite ID for this skin.
2018-12-29 16:05:19 -08:00
<!-- EOF -->