SCRIPTING API / Physics / Collider

Collider

Script access to an entity's Collider: shape, size, offset, trigger flag and collision layers.

Kindclass

NamespaceKroys.EngineScripting

Members41

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

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

Declaration

public static partial class Collider

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Collider component.

methodstatic

#public static ColliderShapeType GetShape(Entity e)

Reads the Collider component's Shape value of the entity.

methodstatic

#public static void SetShape(Entity e, ColliderShapeType value)

Sets the Collider component's Shape value on the entity.

methodstatic

#public static GameplayLayer GetGameplayLayer(Entity e)

Reads the Collider component's Gameplay Layer value of the entity.

methodstatic

#public static void SetGameplayLayer(Entity e, GameplayLayer value)

Sets the Collider component's Gameplay Layer value on the entity.

methodstatic

#public static MeshColliderGeometry GetMeshGeometry(Entity e)

Reads the Collider component's Mesh Geometry value of the entity.

methodstatic

#public static void SetMeshGeometry(Entity e, MeshColliderGeometry value)

Sets the Collider component's Mesh Geometry value on the entity.

methodstatic

#public static uint GetConvexHullMaxPoints(Entity e)

Reads the Collider component's Convex Hull Max Points value of the entity.

methodstatic

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

Sets the Collider component's Convex Hull Max Points value on the entity.

methodstatic

#public static bool IsEnabled(Entity e)

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

methodstatic

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

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

methodstatic

#public static bool IsTrigger(Entity e)

Reads the Collider component's Trigger value of the entity.

methodstatic

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

Sets the Collider component's Trigger value on the entity.

methodstatic

#public static bool DebugDraws(Entity e)

Reads the Collider component's debug draws flag of the entity.

methodstatic

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

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

methodstatic

#public static bool UsesMeshFromRenderer(Entity e)

Reads the Collider component's Mesh From Renderer value of the entity.

methodstatic

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

Sets the Collider component's Use Mesh From Renderer value on the entity.

methodstatic

#public static Vector3 GetLocalOffset(Entity e)

Reads the Collider component's Local Offset value of the entity.

methodstatic

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

Sets the Collider component's Local Offset value on the entity.

methodstatic

#public static Vector3 GetLocalRotation(Entity e)

Reads the Collider component's Local Rotation value of the entity.

methodstatic

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

Sets the Collider component's Local Rotation value on the entity.

methodstatic

#public static Vector3 GetBoxHalfExtents(Entity e)

Reads the Collider component's Box Half Extents value of the entity.

methodstatic

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

Sets the Collider component's Box Half Extents value on the entity.

methodstatic

#public static float GetSphereRadius(Entity e)

Reads the Collider component's Sphere Radius value of the entity.

methodstatic

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

Sets the Collider component's Sphere Radius value on the entity.

methodstatic

#public static float GetCapsuleRadius(Entity e)

Reads the Collider component's Capsule Radius value of the entity.

methodstatic

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

Sets the Collider component's Capsule Radius value on the entity.

methodstatic

#public static float GetCapsuleHeight(Entity e)

Reads the Collider component's Capsule Height value of the entity.

methodstatic

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

Sets the Collider component's Capsule Height value on the entity.

methodstatic

#public static uint GetCollisionLayer(Entity e)

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

methodstatic

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

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

methodstatic

#public static uint GetCollisionMask(Entity e)

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

methodstatic

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

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

methodstatic

#public static float GetStaticFriction(Entity e)

Reads the Collider component's Static Friction value of the entity.

methodstatic

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

Sets the Collider component's Static Friction value on the entity.

methodstatic

#public static float GetDynamicFriction(Entity e)

Reads the Collider component's Dynamic Friction value of the entity.

methodstatic

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

Sets the Collider component's Dynamic Friction value on the entity.

methodstatic

#public static float GetRestitution(Entity e)

Reads the Collider component's Restitution value of the entity.

methodstatic

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

Sets the Collider component's Restitution value on the entity.

methodstatic

#public static ulong GetMesh(Entity e)

Reads the Collider component's Mesh value of the entity.

methodstatic

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

Sets the Collider component's Mesh value on the entity.

methodstatic

Signatures

public static bool Has(Entity e)
public static ColliderShapeType GetShape(Entity e)
public static void SetShape(Entity e, ColliderShapeType value)
public static GameplayLayer GetGameplayLayer(Entity e)
public static void SetGameplayLayer(Entity e, GameplayLayer value)
public static MeshColliderGeometry GetMeshGeometry(Entity e)
public static void SetMeshGeometry(Entity e, MeshColliderGeometry value)
public static uint GetConvexHullMaxPoints(Entity e)
public static void SetConvexHullMaxPoints(Entity e, uint value)
public static bool IsEnabled(Entity e)
public static void SetEnabled(Entity e, bool value)
public static bool IsTrigger(Entity e)
public static void SetTrigger(Entity e, bool value)
public static bool DebugDraws(Entity e)
public static void SetDebugDraw(Entity e, bool value)
public static bool UsesMeshFromRenderer(Entity e)
public static void SetUseMeshFromRenderer(Entity e, bool value)
public static Vector3 GetLocalOffset(Entity e)
public static void SetLocalOffset(Entity e, Vector3 value)
public static Vector3 GetLocalRotation(Entity e)
public static void SetLocalRotation(Entity e, Vector3 value)
public static Vector3 GetBoxHalfExtents(Entity e)
public static void SetBoxHalfExtents(Entity e, Vector3 value)
public static float GetSphereRadius(Entity e)
public static void SetSphereRadius(Entity e, float value)
public static float GetCapsuleRadius(Entity e)
public static void SetCapsuleRadius(Entity e, float value)
public static float GetCapsuleHeight(Entity e)
public static void SetCapsuleHeight(Entity e, float value)
public static uint GetCollisionLayer(Entity e)
public static void SetCollisionLayer(Entity e, uint value)
public static uint GetCollisionMask(Entity e)
public static void SetCollisionMask(Entity e, uint value)
public static float GetStaticFriction(Entity e)
public static void SetStaticFriction(Entity e, float value)
public static float GetDynamicFriction(Entity e)
public static void SetDynamicFriction(Entity e, float value)
public static float GetRestitution(Entity e)
public static void SetRestitution(Entity e, float value)
public static ulong GetMesh(Entity e)
public static void SetMesh(Entity e, ulong value)

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