SCRIPTING API / Rendering and effects / Cloth

Cloth

Script access to an entity's Cloth simulation settings.

Kindclass

NamespaceKroys.EngineScripting

Members62

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

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

Declaration

public static partial class Cloth

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Cloth component.

methodstatic

#public static bool IsEnabled(Entity e)

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

methodstatic

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

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

methodstatic

#public static bool IsPaused(Entity e)

Reads the Cloth component's Paused value of the entity.

methodstatic

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

Sets the Cloth component's Paused value on the entity.

methodstatic

#public static void Reset(Entity e)

Reset on the entity's Cloth component.

methodstatic

#public static bool IsDebugDrawEnabled(Entity e)

Reads the Cloth component's Debug Draw Enabled value of the entity.

methodstatic

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

Sets the Cloth component's Debug Draw value on the entity.

methodstatic

#public static bool FollowsSkinning(Entity e)

Reads the Cloth component's follows skinning flag of the entity.

methodstatic

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

Sets the Cloth component's Follow Skinning value on the entity.

methodstatic

#public static bool IsSelfCollisionEnabled(Entity e)

Reads the Cloth component's Self Collision Enabled value of the entity.

methodstatic

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

Sets the Cloth component's Self Collision Enabled value on the entity.

methodstatic

#public static bool IsPinPaintingEnabled(Entity e)

Reads the Cloth component's Pin Painting Enabled value of the entity.

methodstatic

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

Sets the Cloth component's Pin Painting Enabled value on the entity.

methodstatic

#public static bool UsesWorldGravity(Entity e)

Reads the Cloth component's World Gravity value of the entity.

methodstatic

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

Sets the Cloth component's Use World Gravity value on the entity.

methodstatic

#public static bool IsCollisionEnabled(Entity e)

Reads the Cloth component's Collision Enabled value of the entity.

methodstatic

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

Sets the Cloth component's Collision Enabled value on the entity.

methodstatic

#public static bool CollidesWithOwnerHierarchy(Entity e)

Reads the Cloth component's collides with owner hierarchy flag of the entity.

methodstatic

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

Sets the Cloth component's Collide With Owner Hierarchy value on the entity.

methodstatic

#public static float GetPinPaintRadius(Entity e)

Reads the Cloth component's Pin Paint Radius value of the entity.

methodstatic

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

Sets the Cloth component's Pin Paint Radius value on the entity.

methodstatic

#public static float GetPinPaintStrength(Entity e)

Reads the Cloth component's Pin Paint Strength value of the entity.

methodstatic

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

Sets the Cloth component's Pin Paint Strength value on the entity.

methodstatic

#public static float GetWindStrength(Entity e)

Reads the Cloth component's Wind Strength value of the entity.

methodstatic

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

Sets the Cloth component's Wind Strength value on the entity.

methodstatic

#public static float GetDamping(Entity e)

Reads the Cloth component's Damping value of the entity.

methodstatic

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

Sets the Cloth component's Damping value on the entity.

methodstatic

#public static float GetAnimatedMotionTransfer(Entity e)

Reads the Cloth component's Animated Motion Transfer value of the entity.

methodstatic

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

Sets the Cloth component's Animated Motion Transfer value on the entity.

methodstatic

#public static float GetStretchStiffness(Entity e)

Reads the Cloth component's Stretch Stiffness value of the entity.

methodstatic

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

Sets the Cloth component's Stretch Stiffness value on the entity.

methodstatic

#public static float GetShearStiffness(Entity e)

Reads the Cloth component's Shear Stiffness value of the entity.

methodstatic

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

Sets the Cloth component's Shear Stiffness value on the entity.

methodstatic

#public static float GetBendStiffness(Entity e)

Reads the Cloth component's Bend Stiffness value of the entity.

methodstatic

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

Sets the Cloth component's Bend Stiffness value on the entity.

methodstatic

#public static float GetParticleRadius(Entity e)

Reads the Cloth component's Particle Radius value of the entity.

methodstatic

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

Sets the Cloth component's Particle Radius value on the entity.

methodstatic

#public static uint GetSolverIterations(Entity e)

Reads the Cloth component's Solver Iterations value of the entity.

methodstatic

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

Sets the Cloth component's Solver Iterations value on the entity.

methodstatic

#public static uint GetSubsteps(Entity e)

Reads the Cloth component's Substeps value of the entity.

methodstatic

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

Sets the Cloth component's Substeps value on the entity.

methodstatic

#public static uint GetCollisionMask(Entity e)

Reads the Cloth component's Collision Mask value of the entity.

methodstatic

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

Sets the Cloth component's Collision Mask value on the entity.

methodstatic

#public static ClothPinMode GetPinMode(Entity e)

Reads the Cloth component's Pin Mode value of the entity.

methodstatic

#public static void SetPinMode(Entity e, ClothPinMode value)

Sets the Cloth component's Pin Mode value on the entity.

methodstatic

#public static Vector3 GetGravity(Entity e)

Reads the Cloth component's Gravity value of the entity.

methodstatic

#public static void SetGravity(Entity e, Vector3 value)

Sets the Cloth component's Gravity value on the entity.

methodstatic

#public static Vector3 GetWindDirection(Entity e)

Reads the Cloth component's Wind Direction value of the entity.

methodstatic

#public static void SetWindDirection(Entity e, Vector3 value)

Sets the Cloth component's Wind Direction value on the entity.

methodstatic

#public static ulong GetSourceMesh(Entity e)

Reads the Cloth component's Source Mesh value of the entity.

methodstatic

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

Sets the Cloth component's Source Mesh value on the entity.

methodstatic

#public static ulong GetRuntimeMesh(Entity e)

Reads the Cloth component's Runtime Mesh value of the entity.

methodstatic

#public static bool GetShowParticles(Entity e)

Reads the Cloth component's Show Particles value of the entity.

methodstatic

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

Sets the Cloth component's Show Particles value on the entity.

methodstatic

#public static bool GetShowConstraints(Entity e)

Reads the Cloth component's Show Constraints value of the entity.

methodstatic

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

Sets the Cloth component's Show Constraints value on the entity.

methodstatic

#public static bool GetShowPinned(Entity e)

Reads the Cloth component's Show Pinned value of the entity.

methodstatic

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

Sets the Cloth component's Show Pinned value on the entity.

methodstatic

#public static bool GetShowColliders(Entity e)

Reads the Cloth component's Show Colliders value of the entity.

methodstatic

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

Sets the Cloth component's Show Colliders value on the entity.

methodstatic

#public static void SetSourceMesh(Entity e, AssetRef<MeshAsset> value)

Sets the cloth's source mesh from an asset reference.

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 IsPaused(Entity e)
public static void SetPaused(Entity e, bool value)
public static void Reset(Entity e)
public static bool IsDebugDrawEnabled(Entity e)
public static void SetDebugDraw(Entity e, bool value)
public static bool FollowsSkinning(Entity e)
public static void SetFollowSkinning(Entity e, bool value)
public static bool IsSelfCollisionEnabled(Entity e)
public static void SetSelfCollisionEnabled(Entity e, bool value)
public static bool IsPinPaintingEnabled(Entity e)
public static void SetPinPaintingEnabled(Entity e, bool value)
public static bool UsesWorldGravity(Entity e)
public static void SetUseWorldGravity(Entity e, bool value)
public static bool IsCollisionEnabled(Entity e)
public static void SetCollisionEnabled(Entity e, bool value)
public static bool CollidesWithOwnerHierarchy(Entity e)
public static void SetCollideWithOwnerHierarchy(Entity e, bool value)
public static float GetPinPaintRadius(Entity e)
public static void SetPinPaintRadius(Entity e, float value)
public static float GetPinPaintStrength(Entity e)
public static void SetPinPaintStrength(Entity e, float value)
public static float GetWindStrength(Entity e)
public static void SetWindStrength(Entity e, float value)
public static float GetDamping(Entity e)
public static void SetDamping(Entity e, float value)
public static float GetAnimatedMotionTransfer(Entity e)
public static void SetAnimatedMotionTransfer(Entity e, float value)
public static float GetStretchStiffness(Entity e)
public static void SetStretchStiffness(Entity e, float value)
public static float GetShearStiffness(Entity e)
public static void SetShearStiffness(Entity e, float value)
public static float GetBendStiffness(Entity e)
public static void SetBendStiffness(Entity e, float value)
public static float GetParticleRadius(Entity e)
public static void SetParticleRadius(Entity e, float value)
public static uint GetSolverIterations(Entity e)
public static void SetSolverIterations(Entity e, uint value)
public static uint GetSubsteps(Entity e)
public static void SetSubsteps(Entity e, uint value)
public static uint GetCollisionMask(Entity e)
public static void SetCollisionMask(Entity e, uint value)
public static ClothPinMode GetPinMode(Entity e)
public static void SetPinMode(Entity e, ClothPinMode value)
public static Vector3 GetGravity(Entity e)
public static void SetGravity(Entity e, Vector3 value)
public static Vector3 GetWindDirection(Entity e)
public static void SetWindDirection(Entity e, Vector3 value)
public static ulong GetSourceMesh(Entity e)
public static void SetSourceMesh(Entity e, ulong value)
public static ulong GetRuntimeMesh(Entity e)
public static bool GetShowParticles(Entity e)
public static void SetShowParticles(Entity e, bool value)
public static bool GetShowConstraints(Entity e)
public static void SetShowConstraints(Entity e, bool value)
public static bool GetShowPinned(Entity e)
public static void SetShowPinned(Entity e, bool value)
public static bool GetShowColliders(Entity e)
public static void SetShowColliders(Entity e, bool value)
public static void SetSourceMesh(Entity e, AssetRef<MeshAsset> value)

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