SCRIPTING API / Animation / Ragdoll

Ragdoll

Script access to an entity's Ragdoll: switching between animation and physics and blending between them.

Kindclass

NamespaceKroys.EngineScripting

Members20

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

Component access: every member takes the entity first, for example Ragdoll.Has(Entity). The values are the ones the Inspector shows for this component.

Declaration

public static partial class Ragdoll

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Ragdoll component.

methodstatic

#public static bool IsEnabled(Entity e)

Reads the Ragdoll component's Enabled value of the entity.

methodstatic

#public static void SetEnabled(Entity e, bool value)

Sets the Ragdoll component's Enabled value on the entity.

methodstatic

#public static bool UsesPhysicsPose(Entity e)

Reads the Ragdoll component's Physics Pose value of the entity.

methodstatic

#public static void SetUsePhysicsPose(Entity e, bool value)

Sets the Ragdoll component's Use Physics Pose value on the entity.

methodstatic

#public static RagdollMode GetMode(Entity e)

Reads the Ragdoll component's Mode value of the entity.

methodstatic

#public static void SetMode(Entity e, RagdollMode mode)

Animated follows the animation, Simulated goes limp, Blend powers the ragdoll toward the animation; changes blend over the blend times.

methodstatic

#public static float GetPhysicsBlendWeight(Entity e)

Reads the Ragdoll component's Physics Blend Weight value of the entity.

methodstatic

#public static void SetPhysicsBlendWeight(Entity e, float value)

Sets the Ragdoll component's Physics Blend Weight value on the entity.

methodstatic

#public static float GetMotorStrength(Entity e)

Reads the Ragdoll component's Motor Strength value of the entity.

methodstatic

#public static void SetMotorStrength(Entity e, float value)

Sets the Ragdoll component's Motor Strength value on the entity.

methodstatic

#public static float GetBlendInTime(Entity e)

Reads the Ragdoll component's Blend In Time value of the entity.

methodstatic

#public static void SetBlendInTime(Entity e, float value)

Sets the Ragdoll component's Blend In Time value on the entity.

methodstatic

#public static float GetBlendOutTime(Entity e)

Reads the Ragdoll component's Blend Out Time value of the entity.

methodstatic

#public static void SetBlendOutTime(Entity e, float value)

Sets the Ragdoll component's Blend Out Time value on the entity.

methodstatic

#public static float GetPhysicsWeight(Entity e)

How much of the physics pose is shown now (0 animation, 1 physics).

methodstatic

#public static ulong GetRigDefinition(Entity e)

Reads the Ragdoll component's Rig Definition value of the entity.

methodstatic

#public static void SetRigDefinition(Entity e, ulong value)

Sets the Ragdoll component's Rig Definition value on the entity.

methodstatic

#public static uint GetCollisionLayer(Entity e)

Reads the Ragdoll component's Collision Layer value of the entity.

methodstatic

#public static void SetCollisionLayer(Entity e, uint value)

Sets the Ragdoll component's Collision Layer value on the entity.

methodstatic

Signatures

public static bool Has(Entity e)
public static bool IsEnabled(Entity e)
public static void SetEnabled(Entity e, bool value)
public static bool UsesPhysicsPose(Entity e)
public static void SetUsePhysicsPose(Entity e, bool value)
public static RagdollMode GetMode(Entity e)
public static void SetMode(Entity e, RagdollMode mode)
public static float GetPhysicsBlendWeight(Entity e)
public static void SetPhysicsBlendWeight(Entity e, float value)
public static float GetMotorStrength(Entity e)
public static void SetMotorStrength(Entity e, float value)
public static float GetBlendInTime(Entity e)
public static void SetBlendInTime(Entity e, float value)
public static float GetBlendOutTime(Entity e)
public static void SetBlendOutTime(Entity e, float value)
public static float GetPhysicsWeight(Entity e)
public static ulong GetRigDefinition(Entity e)
public static void SetRigDefinition(Entity e, ulong value)
public static uint GetCollisionLayer(Entity e)
public static void SetCollisionLayer(Entity e, uint value)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.