Barotrauma Client Doc
Barotrauma.FishRunParams Class Reference
Inheritance diagram for Barotrauma.FishRunParams:
Barotrauma.FishGroundedParams Barotrauma.GroundedMovementParams Barotrauma.IFishAnimation Barotrauma.AnimationParams Barotrauma.EditableParams Barotrauma.IMemorizable< AnimationParams > Barotrauma.ISerializableEntity

Public Member Functions

override void StoreSnapshot ()
 
- Public Member Functions inherited from Barotrauma.AnimationParams
bool Serialize ()
 
bool Deserialize ()
 
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

static FishRunParams GetDefaultAnimParams (Character character)
 
static FishRunParams GetAnimParams (Character character, string fileName=null)
 
- 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)
 

Static Protected Attributes

static FishRunParams Empty = new FishRunParams()
 
- Static Protected Attributes inherited from Barotrauma.AnimationParams
static Dictionary< Identifier, Dictionary< string, AnimationParams > > allAnimations = new Dictionary<Identifier, Dictionary<string, AnimationParams>>()
 

Additional Inherited Members

- 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.FishGroundedParams
static bool Check (Character character)
 
- 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
 
- Properties inherited from Barotrauma.FishGroundedParams
bool Flip [get, set]
 
float FlipCooldown [get, set]
 
float FlipDelay [get, set]
 
float HeadMoveForce [get, set]
 
float TorsoMoveForce [get, set]
 
float FootMoveForce [get, set]
 
float TailTorque [get, set]
 
float LegTorque [get, set]
 
float ColliderStandAngle [get, set]
 The angle of the collider when standing (i.e. out of water). In degrees. More...
 
float ColliderStandAngleInRadians [get]
 
string FootAngles [get, set]
 
Dictionary< int, float > FootAnglesInRadians = new Dictionary<int [get, set]
 Key = limb id, value = angle in radians More...
 
float? TailAngle [get, set]
 In degrees. More...
 
float TailAngleInRadians = float.NaN [get]
 
- Properties inherited from Barotrauma.GroundedMovementParams
Vector2 StepSize [get, set]
 
float HeadPosition [get, set]
 
float TorsoPosition [get, set]
 
float StepLiftHeadMultiplier [get, set]
 
float StepLiftAmount [get, set]
 
bool MultiplyByDir [get, set]
 
float StepLiftOffset [get, set]
 
float StepLiftFrequency [get, set]
 
float BackwardsMovementMultiplier [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]
 
- Properties inherited from Barotrauma.IFishAnimation
string FootAngles [get, set]
 
Dictionary< int, float > FootAnglesInRadians [get, set]
 
float TailAngle [get, set]
 
float TailAngleInRadians [get]
 
float TailTorque [get, set]
 
bool Flip [get, set]
 
float FlipCooldown [get, set]
 
float FlipDelay [get, set]
 

Detailed Description

Definition at line 22 of file FishAnimations.cs.

Member Function Documentation

◆ GetAnimParams()

static FishRunParams Barotrauma.FishRunParams.GetAnimParams ( Character  character,
string  fileName = null 
)
static

Definition at line 28 of file FishAnimations.cs.

◆ GetDefaultAnimParams()

static FishRunParams Barotrauma.FishRunParams.GetDefaultAnimParams ( Character  character)
static

Definition at line 24 of file FishAnimations.cs.

◆ StoreSnapshot()

override void Barotrauma.FishRunParams.StoreSnapshot ( )
virtual

Member Data Documentation

◆ Empty

FishRunParams Barotrauma.FishRunParams.Empty = new FishRunParams()
staticprotected

Definition at line 33 of file FishAnimations.cs.