GetPlayerSkin: Difference between revisions
DrinkyBird (talk | contribs) (Documented GetPlayerSkin) Tag: Source edit |
m (Renamed constants.) Tag: Source edit |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
=== Parameters === | === Parameters === | ||
* ''player'': The player number to get the | * ''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. | ::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 | ::The skin that is currently visible. | ||
=== Return value === | === Return value === | ||
| Line 23: | Line 23: | ||
== Examples == | == Examples == | ||
{{noexamples}} | {{noexamples}} | ||
== See also == | |||
* [[SetPlayerSkin]] | |||
[[Category: ACS functions]] | [[Category: ACS functions]] | ||
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
skinCVar).
- 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. |