Barotrauma Server
Loading...
Searching...
No Matches
Barotrauma.FishSwimParams Class Referenceabstract
Inheritance diagram for Barotrauma.FishSwimParams:
Barotrauma.SwimParams Barotrauma.IFishAnimation Barotrauma.AnimationParams Barotrauma.EditableParams Barotrauma.IMemorizable< AnimationParams > Barotrauma.ISerializableEntity Barotrauma.FishSwimFastParams Barotrauma.FishSwimSlowParams

Properties

bool UseSineMovement [get, set]
 
bool Flip [get, set]
 
float FlipCooldown [get, set]
 
float FlipDelay [get, set]
 
bool Mirror [get, set]
 
bool MirrorLerp [get, set]
 
float WaveAmplitude [get, set]
 
float WaveLength [get, set]
 
bool RotateTowardsMovement [get, set]
 
float TailTorque [get, set]
 
float TailTorqueMultiplier [get, set]
 
string FootAngles [get, set]
 
bool UpdateAnimationWhenNotMoving [get, set]
 
Dictionary< int, float > FootAnglesInRadians = new Dictionary<int, float>() [get, set]
 Key = limb id, value = angle in radians.
 
float TailAngle [get, set]
 In degrees.
 
float TailAngleInRadians = float.NaN [get]
 
- Properties inherited from Barotrauma.SwimParams
float SteerTorque [get, set]
 
float LegTorque [get, set]
 
- Properties inherited from Barotrauma.AnimationParams
Identifier SpeciesName [get]
 
bool IsGroundedAnimation [get]
 
bool IsSwimAnimation [get]
 
virtual AnimationType AnimationType [get, protected set]
 
float MovementSpeed [get, set]
 
float CycleSpeed [get, set]
 
float HeadAngle [get, set]
 In degrees.
 
float HeadAngleInRadians = float.NaN [get]
 
float TorsoAngle [get, set]
 In degrees.
 
float TorsoAngleInRadians = float.NaN [get]
 
float HeadTorque [get, set]
 
float TorsoTorque [get, set]
 
float FootTorque [get, set]
 
float ArmIKStrength [get, set]
 
float HandIKStrength [get, set]
 
Memento< AnimationParamsMemento = new Memento<AnimationParams>() [get, protected set]
 
- Properties inherited from Barotrauma.EditableParams
bool IsLoaded [get, protected set]
 
string Name [get]
 
string FileName [get]
 
string FileNameWithoutExtension [get]
 
string Folder [get]
 
ContentPath Path = ContentPath.Empty [get, protected set]
 
Dictionary< Identifier, SerializablePropertySerializableProperties [get, protected set]
 
virtual ContentXElement MainElement [get]
 
ContentXElement OriginalElement [get, protected set]
 
- Properties inherited from Barotrauma.ISerializableEntity
- Properties inherited from Barotrauma.IMemorizable< AnimationParams >
Memento< T > Memento [get]
 
- Properties inherited from Barotrauma.IFishAnimation

Additional Inherited Members

- Public Member Functions inherited from Barotrauma.AnimationParams
bool Serialize ()
 
bool Deserialize ()
 
void StoreSnapshot ()
 
void Undo ()
 
void Redo ()
 
void ClearHistory ()
 
- Public Member Functions inherited from Barotrauma.EditableParams
virtual bool Save (string fileNameWithoutExtension=null, System.Xml.XmlWriterSettings settings=null)
 
virtual bool Reset (bool forceReload=false)
 
- Public Member Functions inherited from Barotrauma.IMemorizable< AnimationParams >
void StoreSnapshot ()
 
void Undo ()
 
void Redo ()
 
void ClearHistory ()
 
- Static Public Member Functions inherited from Barotrauma.AnimationParams
static string GetDefaultFileName (Identifier speciesName, AnimationType animType)
 
static string GetDefaultFile (Identifier speciesName, AnimationType animType)
 
static string GetFolder (Identifier speciesName)
 
static IEnumerable< string > FilterAndSortFiles (IEnumerable< string > filePaths, AnimationType type)
 Selects all file paths that match the specified animation type and filters them alphabetically.
 
static void ClearCache ()
 
static AnimationParams Create (string fullPath, Identifier speciesName, AnimationType animationType, Type animationParamsType)
 
static T Create< T > (string fullPath, Identifier speciesName, AnimationType animationType)
 Note: Overrides old animations, if found!
 
static Type GetParamTypeFromAnimType (AnimationType type, bool isHumanoid)
 
- Protected Member Functions inherited from Barotrauma.AnimationParams
bool Load (ContentPath file, Identifier speciesName)
 
override void UpdatePath (ContentPath newPath)
 
void StoreSnapshot< T > ()
 
- Protected Member Functions inherited from Barotrauma.EditableParams
ContentXElement CreateElement (string name, params object[] attrs)
 
virtual string GetName ()
 
virtual bool Deserialize (XElement element=null)
 
virtual bool Serialize (XElement element=null)
 
virtual bool Load (ContentPath file)
 
- Static Protected Member Functions inherited from Barotrauma.AnimationParams
static T GetDefaultAnimParams< T > (Character character, AnimationType animType)
 
static T GetAnimParams< T > (Character character, AnimationType animType, Either< string, ContentPath > file, bool throwErrors=true)
 
static string ParseFootAngles (Dictionary< int, float > footAngles)
 
static void SetFootAngles (Dictionary< int, float > footAngles, string value)
 
- Protected Attributes inherited from Barotrauma.EditableParams
ContentXElement rootElement
 
XDocument doc
 

Property Documentation

◆ Flip

bool Barotrauma.FishSwimParams.Flip
getset

◆ FlipCooldown

float Barotrauma.FishSwimParams.FlipCooldown
getset

◆ FlipDelay

float Barotrauma.FishSwimParams.FlipDelay
getset

◆ FootAngles

string Barotrauma.FishSwimParams.FootAngles
getset

◆ FootAnglesInRadians

Dictionary<int, float> Barotrauma.FishSwimParams.FootAnglesInRadians = new Dictionary<int, float>()
getset

Key = limb id, value = angle in radians.

Implements Barotrauma.IFishAnimation.

◆ Mirror

bool Barotrauma.FishSwimParams.Mirror
getset

◆ MirrorLerp

bool Barotrauma.FishSwimParams.MirrorLerp
getset

◆ RotateTowardsMovement

bool Barotrauma.FishSwimParams.RotateTowardsMovement
getset

◆ TailAngle

float Barotrauma.FishSwimParams.TailAngle
getset

In degrees.

Implements Barotrauma.IFishAnimation.

◆ TailAngleInRadians

float Barotrauma.FishSwimParams.TailAngleInRadians = float.NaN
get

◆ TailTorque

float Barotrauma.FishSwimParams.TailTorque
getset

◆ TailTorqueMultiplier

float Barotrauma.FishSwimParams.TailTorqueMultiplier
getset

◆ UpdateAnimationWhenNotMoving

bool Barotrauma.FishSwimParams.UpdateAnimationWhenNotMoving
getset

◆ UseSineMovement

bool Barotrauma.FishSwimParams.UseSineMovement
getset

◆ WaveAmplitude

float Barotrauma.FishSwimParams.WaveAmplitude
getset

◆ WaveLength

float Barotrauma.FishSwimParams.WaveLength
getset

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