KROYSDOCS
HomeWhat's newv0.1.0
SCRIPTING API / Physics / Constraint

Constraint

Script access to an entity's physics Constraint (joint) between two bodies.

Kindclass
NamespaceKroys.EngineScripting
Members13
SourceGenerated/NativeComponents.g.cs, NativeComponents.cs
DECLARATION

Declaration

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

Declaration
public static partial class Constraint
REFERENCE

Members

Methods
#public static bool Has(Entity e)
Whether the entity has a Constraint component.
methodstatic
#public static bool IsEnabled(Entity e)
Reads the Constraint component's Enabled value of the entity.
methodstatic
#public static void SetEnabled(Entity e, bool value)
Sets the Constraint component's Enabled value on the entity.
methodstatic
#public static Entity GetConnectedEntity(Entity e)
Reads the Constraint component's Connected Entity value of the entity.
methodstatic
#public static void SetConnectedEntity(Entity e, Entity value)
Sets the Constraint component's Connected Entity value on the entity.
methodstatic
#public static Vector3 GetLocalAnchor(Entity e)
Reads the Constraint component's Local Anchor value of the entity.
methodstatic
#public static void SetLocalAnchor(Entity e, Vector3 value)
Sets the Constraint component's Local Anchor value on the entity.
methodstatic
#public static Vector3 GetConnectedAnchor(Entity e)
Reads the Constraint component's Connected Anchor value of the entity.
methodstatic
#public static void SetConnectedAnchor(Entity e, Vector3 value)
Sets the Constraint component's Connected Anchor value on the entity.
methodstatic
#public static float GetLinearStiffness(Entity e)
Reads the Constraint component's Linear Stiffness value of the entity.
methodstatic
#public static void SetLinearStiffness(Entity e, float value)
Sets the Constraint component's Linear Stiffness value on the entity.
methodstatic
#public static bool GetDebugDraw(Entity e)
Reads the Constraint component's Debug Draw value of the entity.
methodstatic
#public static void SetDebugDraw(Entity e, bool value)
Sets the Constraint component's Debug Draw 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 Entity GetConnectedEntity(Entity e)
public static void SetConnectedEntity(Entity e, Entity value)
public static Vector3 GetLocalAnchor(Entity e)
public static void SetLocalAnchor(Entity e, Vector3 value)
public static Vector3 GetConnectedAnchor(Entity e)
public static void SetConnectedAnchor(Entity e, Vector3 value)
public static float GetLinearStiffness(Entity e)
public static void SetLinearStiffness(Entity e, float value)
public static bool GetDebugDraw(Entity e)
public static void SetDebugDraw(Entity e, bool value)

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