Barotrauma Client Doc
Barotrauma.SwimParams Class Reference
Inheritance diagram for Barotrauma.SwimParams:
Barotrauma.AnimationParams Barotrauma.EditableParams Barotrauma.IMemorizable< AnimationParams > Barotrauma.ISerializableEntity Barotrauma.FishSwimParams Barotrauma.HumanSwimParams Barotrauma.FishSwimFastParams Barotrauma.FishSwimSlowParams Barotrauma.HumanSwimFastParams Barotrauma.HumanSwimSlowParams

Properties

float SteerTorque [get, set]
 
float LegTorque [get, set]
 
- Properties inherited from Barotrauma.AnimationParams
Identifier SpeciesName [get]
 
bool IsGroundedAnimation [get]
 
bool IsSwimAnimation [get]
 
float MovementSpeed [get, set]
 
float CycleSpeed [get, set]
 
float? HeadAngle [get, set]
 In degrees. More...
 
float HeadAngleInRadians = float.NaN [get]
 
float? TorsoAngle [get, set]
 In degrees. More...
 
float TorsoAngleInRadians = float.NaN [get]
 
float HeadTorque [get, set]
 
float TorsoTorque [get, set]
 
float FootTorque [get, set]
 
virtual AnimationType AnimationType [get, protected 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 Folder [get]
 
ContentPath Path = ContentPath.Empty [get, protected set]
 
Dictionary< Identifier, SerializablePropertySerializableProperties [get, protected set]
 
virtual ContentXElementMainElement [get]
 
ContentXElement OriginalElement [get, protected set]
 
SerializableEntityEditor SerializableEntityEditor [get, protected set]
 
- Properties inherited from Barotrauma.ISerializableEntity
string Name [get]
 
Dictionary< Identifier, SerializablePropertySerializableProperties [get]
 
- Properties inherited from Barotrauma.IMemorizable< AnimationParams >
Memento< T > Memento [get]
 

Additional Inherited Members

- Public Member Functions inherited from Barotrauma.AnimationParams
bool Serialize ()
 
bool Deserialize ()
 
abstract 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)
 
virtual void AddToEditor (ParamsEditor editor, int space=0)
 
- 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 string GetRandomFilePath (IReadOnlyList< string > filePaths, AnimationType type)
 Selects a random filepath from multiple paths, matching the specified animation type. More...
 
static IEnumerable< string > FilterFilesByType (IEnumerable< string > filePaths, AnimationType type)
 Selects all file paths that match the specified animation type. More...
 
static T GetDefaultAnimParams< T > (Character character, AnimationType animType)
 
static T GetAnimParams< T > (Identifier speciesName, AnimationType animType, string fileName=null)
 If the file name is left null, default file is selected. If fails, will select the default file. Note: Use the filename without the extensions, don't use the full path! If a custom folder is used, it's defined in the character info file. More...
 
static void ClearCache ()
 
static AnimationParams Create (string fullPath, Identifier speciesName, AnimationType animationType, Type type)
 
static T Create< T > (string fullPath, Identifier speciesName, AnimationType animationType)
 Note: Overrides old animations, if found! More...
 
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 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
 
- Static Protected Attributes inherited from Barotrauma.AnimationParams
static Dictionary< Identifier, Dictionary< string, AnimationParams > > allAnimations = new Dictionary<Identifier, Dictionary<string, AnimationParams>>()
 

Detailed Description

Definition at line 56 of file AnimationParams.cs.

Property Documentation

◆ LegTorque

float Barotrauma.SwimParams.LegTorque
getset

Definition at line 62 of file AnimationParams.cs.

◆ SteerTorque

float Barotrauma.SwimParams.SteerTorque
getset

Definition at line 59 of file AnimationParams.cs.