GetPlayerSkin: Difference between revisions
m (Renamed GETPLAYERSKIN_ACTUAL to GETPLAYERSKIN_VISIBLE.) Tag: Source edit |
m (Renamed constants.) Tag: Source edit |
||
Line 9: | Line 9: | ||
* ''player'': The player number to get the skin of. | * ''player'': The player number to get the skin of. | ||
* ''type'': Type of skin to retrieve: | * ''type'': Type of skin to retrieve: | ||
:* ''' | :* '''PLAYERSKIN_USERINFO (0)''' | ||
::The player's skin setting (the <code>skin</code> CVar). | ::The player's skin setting (the <code>skin</code> CVar). | ||
:* ''' | :* '''PLAYERSKIN_WEAPON (1)''' | ||
::The preferred skin of the player's current weapon, as defined with [[DECORATE#Actor_properties|Weapon.PreferredSkin]]. | ::The preferred skin of the player's current weapon, as defined with [[DECORATE#Actor_properties|Weapon.PreferredSkin]]. | ||
:* ''' | :* '''PLAYERSKIN_ACS (2)''' | ||
::The player's skin as set by [[SetPlayerSkin]]. | ::The player's skin as set by [[SetPlayerSkin]]. | ||
:* ''' | :* '''PLAYERSKIN_VISIBLE (3)''' | ||
::The skin that is currently visible. | ::The skin that is currently visible. | ||
Latest revision as of 13:30, 16 March 2024
This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports. |
This article documents an ACS function which is only available in development builds of Zandronum 3.2 and newer. |
str GetPlayerSkin (int player, int type)
Usage
Returns a player's skin.
Parameters
- player: The player number to get the skin of.
- type: Type of skin to retrieve:
- PLAYERSKIN_USERINFO (0)
- The player's skin setting (the
skin
CVar).
- PLAYERSKIN_WEAPON (1)
- The preferred skin of the player's current weapon, as defined with Weapon.PreferredSkin.
- PLAYERSKIN_ACS (2)
- The player's skin as set by SetPlayerSkin.
- PLAYERSKIN_VISIBLE (3)
- The skin that is currently visible.
Return value
Returns the name of the player's skin, or an empty string if the player index or their skin is invalid.
Examples
This article lists no examples, please add one. |