Inheritance diagram for Barotrauma.FishRunParams:

Public Member Functions
override void	StoreSnapshot ()

Public Member Functions inherited from Barotrauma.FishGroundedParams
Dictionary< int, float >	float ()

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
static FishRunParams	GetDefaultAnimParams (Character character)

static FishRunParams	GetAnimParams (Character character, Either< string, ContentPath > file, bool throwErrors=true)

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)

Static Protected Attributes
static readonly FishRunParams	Empty = new FishRunParams()

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 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

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.

float	ColliderStandAngleInRadians `[get]`

string	FootAngles `[get, set]`

Dictionary< int, float >	FootAnglesInRadians = new Dictionary<int `[get, set]`
	Key = limb id, value = angle in radians.

float	TailAngle `[get, set]`
	In degrees.

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]`

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< AnimationParams >	Memento = 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, SerializableProperty >	SerializableProperties `[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

Member Function Documentation

◆ GetAnimParams()

static FishRunParams Barotrauma.FishRunParams.GetAnimParams	(	Character	character,
		Either< string, ContentPath >	file,
		bool	throwErrors = true )

static

◆ GetDefaultAnimParams()

static FishRunParams Barotrauma.FishRunParams.GetDefaultAnimParams ( Character character )

static

◆ StoreSnapshot()

override void Barotrauma.FishRunParams.StoreSnapshot ( )

Member Data Documentation

◆ Empty

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

staticprotected

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

/home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Characters/Params/Animation/FishAnimations.cs

Public Member Functions

Static Public Member Functions