Inheritance diagram for Barotrauma.FishAnimController:

Public Member Functions

FishAnimController (Character character, string seed, FishRagdollParams ragdollParams=null)

override void DragCharacter (Character target, float deltaTime)

override void Flip ()

void Mirror (bool lerp=true)

Public Member Functions inherited from Barotrauma.AnimController

AnimController (Character character, string seed, RagdollParams ragdollParams=null)

void UpdateAnimations (float deltaTime)

void DragCharacter (Character target, float deltaTime)

virtual float GetSpeed (AnimationType type)

float GetCurrentSpeed (bool useMaxSpeed)

AnimationParams GetAnimationParamsFromType (AnimationType type)

float GetHeightFromFloor ()

void LockFlipping (float time=0.2f)

void UpdateUseItem (bool allowMovement, Vector2 handWorldPos)

void Grab (Vector2 rightHandPos, Vector2 leftHandPos)

void HoldItem (float deltaTime, Item item, Vector2[] handlePos, Vector2 itemPos, bool aim, float holdAngle, float itemAngleRelativeToHoldAngle=0.0f, bool aimMelee=false, Vector2? targetPos=null)

void HandIK (Limb hand, Vector2 pos, float armTorque=1.0f, float handTorque=1.0f, float maxAngularVelocity=float.PositiveInfinity)

void ApplyPose (Vector2 leftHandPos, Vector2 rightHandPos, Vector2 leftFootPos, Vector2 rightFootPos, float footMoveForce=10)

void ApplyTestPose ()

override void Recreate (RagdollParams ragdollParams=null)

Call this to create the ragdoll from the RagdollParams.

void StartUsingItem ()

void StartClimbing ()

void StopUsingItem ()

void StopClimbing ()

bool TryLoadTemporaryAnimation (StatusEffect.AnimLoadInfo animLoadInfo, bool throwErrors)

Loads an animation (variation) that automatically resets in 0.1s, unless triggered again. Meant e.g. for triggering animations in status effects, without having to worry about resetting them.

bool TryLoadAnimation (AnimationType animationType, Either< string, ContentPath > file, out AnimationParams animParams, bool throwErrors)

Loads animations. Non-permanent (= resets on load).

Public Member Functions inherited from Barotrauma.Ragdoll

bool TryGetCollider (int index, out PhysicsBody collider)

void SubtractMass (Limb limb)

Ragdoll (Character character, string seed, RagdollParams ragdollParams=null)

void SaveRagdoll (string fileNameWithoutExtension=null)

Saves all serializable data in the currently selected ragdoll params. This method should properly handle character flipping.

void ResetRagdoll (bool forceReload=false)

Resets the serializable data to the currently selected ragdoll params. Force reloading always loads the xml stored on the disk.

void ResetJoints ()

Resets the current joint values to the serialized joint params.

void ResetLimbs ()

Resets the current limb values to the serialized limb params.

void AddJoint (JointParams jointParams)

void AddLimb (Limb limb)

void RemoveLimb (Limb limb)

bool OnLimbCollision (Fixture f1, Fixture f2, Contact contact)

float GetImpactDamage (float impact, float? impactTolerance=null)

bool SeverLimbJoint (LimbJoint limbJoint)

Vector2 GetCenterOfMass ()

void MoveLimb (Limb limb, Vector2 pos, float amount, bool pullFromCenter=false)

Parameters

pullFromCenter if false, force is applied to the position of pullJoint

void ResetPullJoints (Func< Limb, bool > condition=null)

void FindHull (Vector2? worldPosition=null, bool setSubmarine=true)

void Teleport (Vector2 moveAmount, Vector2 velocityChange, bool detachProjectiles=true)

void UpdateRagdoll (float deltaTime, Camera cam)

void ForceRefreshFloorY ()

float GetSurfaceY ()

Get the position of the surface of water at the position of the character, in display units (taking into account connected hulls above the hull the character is in)

void SetPosition (Vector2 simPosition, bool lerp=false, bool ignorePlatforms=true, bool forceMainLimbToCollider=false, bool moveLatchers=true)

void HangWithRope ()

void HoldToRope ()

void DragWithRope ()

Limb GetLimb (LimbType limbType, bool excludeSevered=true)

Note that if there are multiple limbs of the same type, only the first (valid) limb is returned.

Vector2? GetMouthPosition ()

Vector2 GetColliderBottom ()

Limb FindLowestLimb ()

void ReleaseStuckLimbs ()

void HideAndDisable (LimbType limbType, float duration=0, bool ignoreCollisions=true)

void RestoreTemporarilyDisabled ()

void Remove ()

Public Attributes
bool	reverse

Public Attributes inherited from Barotrauma.AnimController
Animation	Anim

Public Attributes inherited from Barotrauma.Ragdoll
LimbJoint[]	LimbJoints

Vector2	movement

Structure	Stairs

Direction	TargetDir

bool	forceStanding

bool	forceNotStanding

Protected Member Functions
override void	UpdateAnim (float deltaTime)

Protected Member Functions inherited from Barotrauma.AnimController
float?	GetValidOrNull (AnimationParams p, float? v)

Vector2?	GetValidOrNull (AnimationParams p, Vector2 v)

void	UpdateAnim (float deltaTime)

void	CalculateArmLengths ()

LimbJoint	GetJointBetweenLimbs (LimbType limbTypeA, LimbType limbTypeB)

LimbJoint	GetJoint (LimbType matchingType, IEnumerable< LimbType > ignoredTypes)

bool	TrySwapAnimParams (AnimationParams newParams)
	Simply swaps existing animation parameters as current parameters.

Protected Member Functions inherited from Barotrauma.Ragdoll
void	CreateColliders ()

void	CreateJoints ()

void	CreateLimbs ()

void	AddLimb (LimbParams limbParams)

List< Limb >	GetConnectedLimbs (Limb limb)

void	LogAccessedRemovedCharacterError ()

void	StopHangingWithRope ()

void	StopHoldingToRope ()

void	StopGettingDraggedWithRope ()

void	TrySetLimbPosition (Limb limb, Vector2 original, Vector2 simPosition, float rotation, bool lerp=false, bool ignorePlatforms=true)

void	CheckDistFromCollider ()

Properties
override RagdollParams	RagdollParams `[get, protected set]`

FishRagdollParams	FishRagdollParams `[get, protected set]`

FishWalkParams	FishWalkParams `[get, set]`

FishRunParams	FishRunParams `[get, set]`

FishSwimSlowParams	FishSwimSlowParams `[get, set]`

FishSwimFastParams	FishSwimFastParams `[get, set]`

IFishAnimation	CurrentFishAnimation `[get]`

new FishGroundedParams	CurrentGroundedParams `[get]`

new FishSwimParams	CurrentSwimParams `[get]`

float?	TailAngle `[get]`

float	FootTorque `[get]`

float	HeadTorque `[get]`

float	TorsoTorque `[get]`

float	TailTorque `[get]`

float	HeadMoveForce `[get]`

float	TorsoMoveForce `[get]`

float	FootMoveForce `[get]`

override GroundedMovementParams	WalkParams `[get, set]`

override GroundedMovementParams	RunParams `[get, set]`

override SwimParams	SwimSlowParams `[get, set]`

override SwimParams	SwimFastParams `[get, set]`

Properties inherited from Barotrauma.AnimController
Vector2	RightHandIKPos `[get, protected set]`

Vector2	LeftHandIKPos `[get, protected set]`

bool	IsAiming `[get]`

bool	IsAimingMelee `[get]`

bool	Aiming `[get]`

float	ArmLength `[get]`

GroundedMovementParams	WalkParams `[get, set]`

GroundedMovementParams	RunParams `[get, set]`

SwimParams	SwimSlowParams `[get, set]`

SwimParams	SwimFastParams `[get, set]`

AnimationParams	CurrentAnimationParams `[get]`

AnimationType	ForceSelectAnimationType `[get, set]`

GroundedMovementParams	CurrentGroundedParams `[get]`

SwimParams	CurrentSwimParams `[get]`

bool	CanWalk `[get]`

bool	IsMovingBackwards `[get]`

bool	IsMovingFast `[get]`
	Note: Presupposes that the slow speed is lower than the high speed. Otherwise will give invalid results.

List< AnimationParams >	AllAnimParams `[get]`
	Note: creates a new list every time, because the params might have changed. If there is a need to access the property frequently, change the implementation to an array, where the slot is updated when the param is updated(?) Currently it's not simple to implement, since the properties are not implemented here, but in the derived classes. Would require to change the params virtual and to call the base property getter/setter or something.

bool	IsUsingItem `[get]`

bool	IsClimbing `[get]`

Vector2	AimSourceWorldPos `[get]`

Vector2	AimSourcePos `[get]`

virtual Vector2	AimSourceSimPos `[get]`

override? float	HeadPosition `[get]`

override? float	TorsoPosition `[get]`

override? float	HeadAngle `[get]`

override? float	TorsoAngle `[get]`

virtual ? Vector2	StepSize `[get]`

bool	AnimationTestPose `[get, set]`

float	WalkPos `[get, protected set]`

bool	IsAboveFloor `[get]`

float	FlipLockTime `[get]`

Properties inherited from Barotrauma.Ragdoll
RagdollParams	RagdollParams `[get, protected set]`

Limb[]	Limbs `[get]`

bool	HasMultipleLimbsOfSameType `[get]`

bool	Frozen `[get, set]`

Character	Character `[get]`

bool	OnGround `[get]`

float	ColliderHeightFromFloor `[get]`
	In sim units. Joint scale applied.

bool	IsStuck `[get]`

PhysicsBody	Collider `[get]`

int	ColliderIndex `[get, set]`

float	FloorY `[get]`

float	Mass `[get]`

Limb	MainLimb `[get]`

Vector2	WorldPosition `[get]`

bool	SimplePhysicsEnabled `[get, set]`

Vector2	TargetMovement `[get, set]`

float?	HeadPosition `[get]`

float?	HeadAngle `[get]`

float?	TorsoPosition `[get]`

float?	TorsoAngle `[get]`

float	ImpactTolerance `[get]`

bool	Draggable `[get]`

CanEnterSubmarine	CanEnterSubmarine `[get]`

float	Dir `[get]`

Direction	Direction `[get]`

bool	InWater `[get]`

bool	HeadInWater `[get]`

Hull	CurrentHull `[get, set]`

bool	IgnorePlatforms `[get, set]`

bool	IsFlipped `[get]`

bool	BodyInRest `[get, set]`

bool	Invalid `[get]`

bool	IsHoldingToRope `[get]`
	Is attached to something with a rope.

bool	IsHangingWithRope `[get]`
	Is hanging to something with a rope, so that can reel towards it. Currently only possible in water.

bool	IsDraggedWithRope `[get]`
	Has someone attached to the character with a rope?

Additional Inherited Members
Public Types inherited from Barotrauma.AnimController
enum	Animation { None , Climbing , UsingItem , Struggle , CPR , UsingItemWhileClimbing }

Static Public Member Functions inherited from Barotrauma.Ragdoll
static void	UpdateAll (float deltaTime, Camera cam)

static void	RemoveAll ()

Static Public Attributes inherited from Barotrauma.Ragdoll
const float	MAX_SPEED = 20

Protected Attributes inherited from Barotrauma.AnimController
LimbJoint	rightShoulder

LimbJoint	leftShoulder

float	upperArmLength

float	forearmLength

float	useItemTimer

bool	aiming

bool	wasAiming

bool	aimingMelee

bool	wasAimingMelee

readonly Dictionary< AnimationType, AnimSwap >	tempAnimations = new Dictionary<AnimationType, AnimSwap>()

readonly HashSet< AnimationType >	expiredAnimations = new HashSet<AnimationType>()

float	deathAnimTimer

float	deathAnimDuration = 5.0f

Protected Attributes inherited from Barotrauma.Ragdoll
Hull	currentHull

Character	character

float	strongestImpact

Vector2	targetMovement

Vector2	overrideTargetMovement

float	floorY

float	standOnFloorY

Fixture	floorFixture

Vector2	floorNormal = Vector2.UnitY

float	surfaceY

bool	inWater

bool	headInWater

bool	onGround

Direction	dir

List< PhysicsBody >	collider

int	colliderIndex = 0

bool	levitatingCollider = true

bool	shouldHoldToRope

bool	shouldHangWithRope

bool	shouldBeDraggedWithRope

Constructor & Destructor Documentation

◆ FishAnimController()

Barotrauma.FishAnimController.FishAnimController	(	Character	character,
		string	seed,
		FishRagdollParams	ragdollParams = null )

Member Function Documentation

◆ DragCharacter()

override void Barotrauma.FishAnimController.DragCharacter	(	Character	target,
		float	deltaTime )

◆ Flip()

override void Barotrauma.FishAnimController.Flip ( )

virtual

Reimplemented from Barotrauma.Ragdoll.

◆ Mirror()

void Barotrauma.FishAnimController.Mirror ( bool lerp = true )

◆ UpdateAnim()

override void Barotrauma.FishAnimController.UpdateAnim ( float deltaTime )

protected

Member Data Documentation

◆ WalkParams

override GroundedMovementParams Barotrauma.FishAnimController.WalkParams

getset

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Constructor & Destructor Documentation

◆ FishAnimController()

Member Function Documentation

◆ DragCharacter()

◆ Flip()

◆ Mirror()

◆ UpdateAnim()

Member Data Documentation

◆ reverse

Property Documentation

◆ CurrentFishAnimation

◆ CurrentGroundedParams

◆ CurrentSwimParams

◆ FishRagdollParams

◆ FishRunParams

◆ FishSwimFastParams

◆ FishSwimSlowParams

◆ FishWalkParams

◆ FootMoveForce

◆ FootTorque

◆ HeadMoveForce

◆ HeadTorque

◆ RagdollParams

◆ RunParams

◆ SwimFastParams

◆ SwimSlowParams

◆ TailAngle

◆ TailTorque

◆ TorsoMoveForce

◆ TorsoTorque

◆ WalkParams