Cataclysm Core Mono Library (CCML) Documentation
Cataclysm.Component
CCML/Source/Cataclysm/Scene/Components.cs
public abstract class Component;Summary
Cataclysm Component
Properties
| Type | Name | Summary |
|---|---|---|
| Cataclysm.Entity | Entity | Parent entity of the component. |
Cataclysm.Entity
CCML/Source/Cataclysm/Scene/Entity.cs
public class Entity;Summary
Cataclysm Entity
Properties
| Type | Name | Summary |
|---|---|---|
| ulong | ID | [readonly] |
| vec3 | Translation | The entity’s global position in 3D coordinates. |
Methods
| Return Type | Signature | Summary |
|---|---|---|
| bool | HasComponent<T>() where T : Component | Checks if the entity has a component of type T. |
| T | GetComponent<T>() where T : Component | Checks if the entity has a component of type T and returns it. |
| Cataclysm.Entity | FindEntityByName(string name) | Finds an entity with the given name. |
| T | As<T>() where T : Entity |
Cataclysm.Input
CCML/Source/Cataclysm/Input.cs
public class Input;Summary
Cataclysm Input
Methods
| Return Type | Signature | Summary |
|---|---|---|
| bool | IsKeyDown(KeyCode keycode) | [static] Checks if the given key is down. |
Cataclysm.KeyCode
CCML/Source/Cataclysm/KeyCode.cs
public enum KeyCode;Cataclysm.Rigidbody2D
CCML/Source/Cataclysm/Scene/Components.cs
public class Rigidbody2D : Component;Summary
Cataclysm Rigidbody2D Component
Properties
| Type | Name | Summary |
|---|---|---|
| Cataclysm.Vec2 | Velocity | Linear Velocity |
| Cataclysm.Rigidbody2D.BodyType | Type | Rigidbody Type |
Methods
| Return Type | Signature | Summary |
|---|---|---|
| void | ApplyLinearImpulse(Vec2 impulse, Vec2 worldPosition, bool wake) | Applies a linear impulse to the rigidbody at the given position. |
| void | ApplyLinearImpulse(Vec2 impulse, bool wake) | Applies a linear impulse to the rigidbody at the center. |
Cataclysm.Text
CCML/Source/Cataclysm/Scene/Components.cs
public class Text : Component;Summary
Cataclysm Text Component
Properties
| Type | Name | Summary |
|---|---|---|
| string | text | |
| Cataclysm.Vec4 | Color | Text color |
| float | Kerning | |
| float | LineSpacing |
Cataclysm.Transform
CCML/Source/Cataclysm/Scene/Components.cs
public class Transform : Component;Summary
Cataclysm Transform Component
Properties
| Type | Name | Summary |
|---|---|---|
| Cataclysm.Vec3 | Translation |
Cataclysm.Vec2
CCML/Source/Cataclysm/Vec2.cs
public struct Vec2;Summary
Represents a 2-dimensional floating point vector.
Properties
| Type | Name | Summary |
|---|---|---|
| float | X | X-Coordinate |
| float | Y | Y-Coordinate |
| Cataclysm.Vec2 | Zero | [static] Returns a new Vec2 with coordinates (0, 0). |
Methods
| Return Type | Signature | Summary |
|---|---|---|
| Cataclysm.Vec2 | (float scalar) | Constructor |
| Cataclysm.Vec2 | (float x, float y) | Constructor |
| Cataclysm.Vec2 | operator* (Vec2 a, Vec2 b) | [static] |
| Cataclysm.Vec2 | operator* (Vec2 vector, float scalar) | [static] |
| float | MagnitudeSquared() | |
| float | Magnitude() | Returns the absolute length of the vector. |
Cataclysm.Vec3
CCML/Source/Cataclysm/Vec3.cs
public struct Vec3;Summary
Represents a 3-dimensional floating point vector.
Properties
| Type | Name | Summary |
|---|---|---|
| float | X | X-Coordinate |
| float | Y | Y-Coordinate |
| float | Z | Z-Coordinate |
| Cataclysm.Vec3 | Zero | [static] Returns a new Vec3 with coordinates (0, 0, 0). |
Methods
| Return Type | Signature | Summary |
|---|---|---|
| Cataclysm.Vec3 | (float scalar) | Constructor |
| Cataclysm.Vec3 | (float x, float y, float z) | Constructor |
| Cataclysm.Vec3 | (Vec2 xy, float z) | Constructor |
| Cataclysm.Vec3 | operator+ (Vec3 a, Vec3 b) | [static] |
| Cataclysm.Vec3 | operator* (Vec3 vector, float scalar) | [static] |
Cataclysm.Vec4
CCML/Source/Cataclysm/Vec4.cs
public struct Vec4;Summary
Represents a 4-dimensional floating point vector.
Properties
| Type | Name | Summary |
|---|---|---|
| float | X | X-Coordinate |
| float | Y | Y-Coordinate |
| float | Z | Z-Coordinate |
| float | W | W-Coordinate |
| Cataclysm.Vec4 | Zero | [static] Returns a new Vec4 with coordinates (0, 0, 0, 0). |
Methods
| Return Type | Signature | Summary |
|---|---|---|
| Cataclysm.Vec4 | (float scalar) | Constructor |
| Cataclysm.Vec4 | (float x, float y, float z, float w) | Constructor |
| Cataclysm.Vec4 | (Vec3 xyz, float w) | Constructor |
| Cataclysm.Vec4 | operator+ (Vec4 a, Vec4 b) | [static] |
| Cataclysm.Vec4 | operator* (Vec4 vector, float scalar) | [static] |