Barotrauma.WearableSprite Class Reference

Public Types
enum class	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. More...
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. More...
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! More...
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. More...
bool	IsInitialized [get]

Detailed Description

Definition at line 25 of file Wearable.cs.

Member Enumeration Documentation

ObscuringMode

enum Barotrauma.WearableSprite.ObscuringMode

strong

Enumerator
None
Hide
AlphaClip

Definition at line 49 of file Wearable.cs.

Constructor & Destructor Documentation

WearableSprite() [1/2]

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

Definition at line 133 of file Wearable.cs.

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.

Definition at line 155 of file Wearable.cs.

Member Function Documentation

Init()

void Barotrauma.WearableSprite.Init

(

Character

picker = null

)

Definition at line 209 of file Wearable.cs.

ParsePath()

void Barotrauma.WearableSprite.ParsePath

(

bool

parseSpritePath

)

Definition at line 179 of file Wearable.cs.

Property Documentation

AlphaClipOtherWearables

bool Barotrauma.WearableSprite.AlphaClipOtherWearables

get

Definition at line 57 of file Wearable.cs.

CanBeHiddenByItem

ImmutableHashSet<Identifier> Barotrauma.WearableSprite.CanBeHiddenByItem

get

Tags or identifiers of items that can hide this one.

Definition at line 63 of file Wearable.cs.

CanBeHiddenByOtherWearables

bool Barotrauma.WearableSprite.CanBeHiddenByOtherWearables

get

Definition at line 58 of file Wearable.cs.

DepthLimb

LimbType Barotrauma.WearableSprite.DepthLimb

get

Definition at line 80 of file Wearable.cs.

HideLimb

bool Barotrauma.WearableSprite.HideLimb

get

Definition at line 47 of file Wearable.cs.

HideOtherWearables

bool Barotrauma.WearableSprite.HideOtherWearables

get

Definition at line 56 of file Wearable.cs.

HideWearablesOfType

List<WearableType> Barotrauma.WearableSprite.HideWearablesOfType

get

Definition at line 64 of file Wearable.cs.

IgnoreLimbScale

bool Barotrauma.WearableSprite.IgnoreLimbScale

get

Definition at line 71 of file Wearable.cs.

IgnoreRagdollScale

bool Barotrauma.WearableSprite.IgnoreRagdollScale

get

Definition at line 70 of file Wearable.cs.

IgnoreTextureScale

bool Barotrauma.WearableSprite.IgnoreTextureScale

get

Definition at line 72 of file Wearable.cs.

InheritLimbDepth

bool Barotrauma.WearableSprite.InheritLimbDepth

get

Definition at line 65 of file Wearable.cs.

InheritOrigin

bool Barotrauma.WearableSprite.InheritOrigin

get

Definition at line 73 of file Wearable.cs.

InheritScale

bool Barotrauma.WearableSprite.InheritScale

get

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

Definition at line 69 of file Wearable.cs.

InheritSourceRect

bool Barotrauma.WearableSprite.InheritSourceRect

get

Definition at line 74 of file Wearable.cs.

IsInitialized

bool Barotrauma.WearableSprite.IsInitialized

get

Definition at line 208 of file Wearable.cs.

LightComponent

LightComponent Barotrauma.WearableSprite.LightComponent

get

Definition at line 98 of file Wearable.cs.

LightComponents

List<LightComponent> Barotrauma.WearableSprite.LightComponents

get

Definition at line 100 of file Wearable.cs.

Limb

LimbType Barotrauma.WearableSprite.Limb

get

Definition at line 46 of file Wearable.cs.

ObscureOtherWearables

ObscuringMode Barotrauma.WearableSprite.ObscureOtherWearables

get

Definition at line 55 of file Wearable.cs.

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.

Definition at line 120 of file Wearable.cs.

Rotation

float Barotrauma.WearableSprite.Rotation

get

Definition at line 78 of file Wearable.cs.

Scale

float Barotrauma.WearableSprite.Scale

get

Definition at line 76 of file Wearable.cs.

SheetIndex

Point? Barotrauma.WearableSprite.SheetIndex

get

Definition at line 96 of file Wearable.cs.

Sound

string Barotrauma.WearableSprite.Sound

get

Definition at line 95 of file Wearable.cs.

SourceElement

ContentXElement Barotrauma.WearableSprite.SourceElement

get

Definition at line 29 of file Wearable.cs.

Sprite

Sprite Barotrauma.WearableSprite.Sprite

get

Definition at line 33 of file Wearable.cs.

SpritePath

string Barotrauma.WearableSprite.SpritePath

get

Definition at line 28 of file Wearable.cs.

Type

WearableType Barotrauma.WearableSprite.Type

get

Definition at line 31 of file Wearable.cs.

UnassignedSpritePath

ContentPath Barotrauma.WearableSprite.UnassignedSpritePath

get

Definition at line 27 of file Wearable.cs.

Variant

int Barotrauma.WearableSprite.Variant

getset

Definition at line 113 of file Wearable.cs.

WearableComponent

Wearable Barotrauma.WearableSprite.WearableComponent

getset

Definition at line 82 of file Wearable.cs.