Barotrauma Client Doc
Barotrauma.SpriteDeformations.SpriteDeformationParams Class Reference
Inheritance diagram for Barotrauma.SpriteDeformations.SpriteDeformationParams:
Barotrauma.ISerializableEntity Barotrauma.SpriteDeformations.CustomDeformationParams Barotrauma.SpriteDeformations.InflateParams Barotrauma.SpriteDeformations.JointBendDeformationParams Barotrauma.SpriteDeformations.NoiseDeformationParams Barotrauma.SpriteDeformations.PositionalDeformationParams

Public Member Functions

 SpriteDeformationParams (XElement element)
 

Static Public Attributes

static readonly Point ShaderMaxResolution = new Point(15, 15)
 Defined in the shader. More...
 

Properties

int Sync [get]
 A negative value means that the deformation is used only by one sprite only (default). A positive value means that this deformation is or could be used for multiple sprites. This behaviour is not automatic, and has to be implemented for any particular case separately (currently only used in Limbs). More...
 
string Type [get, set]
 
SpriteDeformation.DeformationBlendMode BlendMode [get, set]
 
string Name [get]
 
float Strength [get]
 
float MaxRotation [get]
 
bool UseMovementSine [get, set]
 
bool StopWhenHostIsDead [get, set]
 
bool OnlyInWater [get, set]
 
float SineOffset [get, set]
 Only used if UseMovementSine is enabled. Multiplier for Pi. More...
 
virtual float Frequency = 1 [get, set]
 
Dictionary< Identifier, SerializablePropertySerializableProperties [get, set]
 
Point Resolution [get, set]
 
- Properties inherited from Barotrauma.ISerializableEntity
string Name [get]
 
Dictionary< Identifier, SerializablePropertySerializableProperties [get]
 

Detailed Description

Definition at line 10 of file SpriteDeformation.cs.

Constructor & Destructor Documentation

◆ SpriteDeformationParams()

Barotrauma.SpriteDeformations.SpriteDeformationParams.SpriteDeformationParams ( XElement  element)

Definition at line 86 of file SpriteDeformation.cs.

Member Data Documentation

◆ ShaderMaxResolution

readonly Point Barotrauma.SpriteDeformations.SpriteDeformationParams.ShaderMaxResolution = new Point(15, 15)
static

Defined in the shader.

Definition at line 72 of file SpriteDeformation.cs.

Property Documentation

◆ BlendMode

SpriteDeformation.DeformationBlendMode Barotrauma.SpriteDeformations.SpriteDeformationParams.BlendMode
getset

Definition at line 32 of file SpriteDeformation.cs.

◆ Frequency

virtual float Barotrauma.SpriteDeformations.SpriteDeformationParams.Frequency = 1
getset

Definition at line 61 of file SpriteDeformation.cs.

◆ MaxRotation

float Barotrauma.SpriteDeformations.SpriteDeformationParams.MaxRotation
get

Definition at line 44 of file SpriteDeformation.cs.

◆ Name

string Barotrauma.SpriteDeformations.SpriteDeformationParams.Name
get

Definition at line 38 of file SpriteDeformation.cs.

◆ OnlyInWater

bool Barotrauma.SpriteDeformations.SpriteDeformationParams.OnlyInWater
getset

Definition at line 53 of file SpriteDeformation.cs.

◆ Resolution

Point Barotrauma.SpriteDeformations.SpriteDeformationParams.Resolution
getset

Definition at line 76 of file SpriteDeformation.cs.

◆ SerializableProperties

Dictionary<Identifier, SerializableProperty> Barotrauma.SpriteDeformations.SpriteDeformationParams.SerializableProperties
getset

Definition at line 63 of file SpriteDeformation.cs.

◆ SineOffset

float Barotrauma.SpriteDeformations.SpriteDeformationParams.SineOffset
getset

Only used if UseMovementSine is enabled. Multiplier for Pi.

Definition at line 59 of file SpriteDeformation.cs.

◆ StopWhenHostIsDead

bool Barotrauma.SpriteDeformations.SpriteDeformationParams.StopWhenHostIsDead
getset

Definition at line 50 of file SpriteDeformation.cs.

◆ Strength

float Barotrauma.SpriteDeformations.SpriteDeformationParams.Strength
get

Definition at line 41 of file SpriteDeformation.cs.

◆ Sync

int Barotrauma.SpriteDeformations.SpriteDeformationParams.Sync
get

A negative value means that the deformation is used only by one sprite only (default). A positive value means that this deformation is or could be used for multiple sprites. This behaviour is not automatic, and has to be implemented for any particular case separately (currently only used in Limbs).

Definition at line 18 of file SpriteDeformation.cs.

◆ Type

string Barotrauma.SpriteDeformations.SpriteDeformationParams.Type
getset

Definition at line 25 of file SpriteDeformation.cs.

◆ UseMovementSine

bool Barotrauma.SpriteDeformations.SpriteDeformationParams.UseMovementSine
getset

Definition at line 47 of file SpriteDeformation.cs.