Barotrauma.WearableSprite Class Reference

Public Types
enum	ObscuringMode { None , Hide , AlphaClip }

Public Member Functions
	WearableSprite (ContentXElement subElement, WearableType type)
	WearableSprite (ContentXElement subElement, Wearable wearable, int variant=0)
	Note: this constructor cannot initialize automatically, because the gender is unknown at this point. We only know it when the item is equipped.
void	ParsePath (bool parseSpritePath)
void	Init (Character picker=null)

Properties
ContentPath	UnassignedSpritePath [get]
string	SpritePath [get]
ContentXElement	SourceElement [get]
WearableType	Type [get]
Sprite	Sprite [get]
LimbType	Limb [get]
bool	HideLimb [get]
ObscuringMode	ObscureOtherWearables [get]
bool	HideOtherWearables [get]
bool	AlphaClipOtherWearables [get]
bool	CanBeHiddenByOtherWearables [get]
ImmutableHashSet< Identifier >	CanBeHiddenByItem [get]
	Tags or identifiers of items that can hide this one.
List< WearableType >	HideWearablesOfType [get]
bool	InheritLimbDepth [get]
bool	InheritScale [get]
	Does the wearable inherit all the scalings of the wearer? Also the wearable's own scale is used!
bool	IgnoreRagdollScale [get]
bool	IgnoreLimbScale [get]
bool	IgnoreTextureScale [get]
bool	InheritOrigin [get]
bool	InheritSourceRect [get]
float	Scale [get]
float	Rotation [get]
LimbType	DepthLimb [get]
Wearable	WearableComponent [get, set]
string	Sound [get]
Point?	SheetIndex [get]
LightComponent	LightComponent [get]
List< LightComponent >	LightComponents [get]
int	Variant [get, set]
Character	Picker [get, set]
	None = Any/Not Defined -> no effect. Changing the gender forces re-initialization, because the textures can be different for male and female characters.
bool	IsInitialized [get]

Member Enumeration Documentation

ObscuringMode

enum Barotrauma.WearableSprite.ObscuringMode

Enumerator
None
Hide
AlphaClip

Constructor & Destructor Documentation

WearableSprite() [1/2]

Barotrauma.WearableSprite.WearableSprite	(	ContentXElement	subElement,
		WearableType	type )

WearableSprite() [2/2]

Barotrauma.WearableSprite.WearableSprite	(	ContentXElement	subElement,
		Wearable	wearable,
		int	variant = 0 )

Note: this constructor cannot initialize automatically, because the gender is unknown at this point. We only know it when the item is equipped.

Member Function Documentation

Init()

void Barotrauma.WearableSprite.Init

(

Character

picker = null

)

ParsePath()

void Barotrauma.WearableSprite.ParsePath

(

bool

parseSpritePath

)

Property Documentation

AlphaClipOtherWearables

bool Barotrauma.WearableSprite.AlphaClipOtherWearables

get

CanBeHiddenByItem

ImmutableHashSet<Identifier> Barotrauma.WearableSprite.CanBeHiddenByItem

get

Tags or identifiers of items that can hide this one.

CanBeHiddenByOtherWearables

bool Barotrauma.WearableSprite.CanBeHiddenByOtherWearables

get

DepthLimb

LimbType Barotrauma.WearableSprite.DepthLimb

get

HideLimb

bool Barotrauma.WearableSprite.HideLimb

get

HideOtherWearables

bool Barotrauma.WearableSprite.HideOtherWearables

get

HideWearablesOfType

List<WearableType> Barotrauma.WearableSprite.HideWearablesOfType

get

IgnoreLimbScale

bool Barotrauma.WearableSprite.IgnoreLimbScale

get

IgnoreRagdollScale

bool Barotrauma.WearableSprite.IgnoreRagdollScale

get

IgnoreTextureScale

bool Barotrauma.WearableSprite.IgnoreTextureScale

get

InheritLimbDepth

bool Barotrauma.WearableSprite.InheritLimbDepth

get

InheritOrigin

bool Barotrauma.WearableSprite.InheritOrigin

get

InheritScale

bool Barotrauma.WearableSprite.InheritScale

get

Does the wearable inherit all the scalings of the wearer? Also the wearable's own scale is used!

InheritSourceRect

bool Barotrauma.WearableSprite.InheritSourceRect

get

IsInitialized

bool Barotrauma.WearableSprite.IsInitialized

get

LightComponent

LightComponent Barotrauma.WearableSprite.LightComponent

get

LightComponents

List<LightComponent> Barotrauma.WearableSprite.LightComponents

get

Limb

LimbType Barotrauma.WearableSprite.Limb

get

ObscureOtherWearables

ObscuringMode Barotrauma.WearableSprite.ObscureOtherWearables

get

Picker

Character Barotrauma.WearableSprite.Picker

getset

None = Any/Not Defined -> no effect. Changing the gender forces re-initialization, because the textures can be different for male and female characters.

Rotation

float Barotrauma.WearableSprite.Rotation

get

Scale

float Barotrauma.WearableSprite.Scale

get

SheetIndex

Point? Barotrauma.WearableSprite.SheetIndex

get

Sound

string Barotrauma.WearableSprite.Sound

get

SourceElement

ContentXElement Barotrauma.WearableSprite.SourceElement

get

Sprite

Sprite Barotrauma.WearableSprite.Sprite

get

SpritePath

string Barotrauma.WearableSprite.SpritePath

get

Type

WearableType Barotrauma.WearableSprite.Type

get

UnassignedSpritePath

ContentPath Barotrauma.WearableSprite.UnassignedSpritePath

get

Variant

int Barotrauma.WearableSprite.Variant

getset

WearableComponent

Wearable Barotrauma.WearableSprite.WearableComponent

getset

---

The documentation for this class was generated from the following file:

• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Items/Components/Wearable.cs