Skip to main content

Editor.Components.Physics.Capsule

Class

A capsule-shaped physics collider.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

// Create a scene object with a capsule collider
const obj = scene.createSceneObject('PhysicsObject');
obj.name = 'CapsuleColliderObject';
const collider = obj.addComponent('ColliderComponent');

// Create a capsule shape — commonly used for character controllers
const capsule = Editor.Shape.createCapsuleShape(scene);
capsule.radius = 0.5;
capsule.length = 2.0;
capsule.axis = Editor.Axis.Y;
collider.shape = capsule;

console.log(`Created capsule collider on: ${obj.name}`);
console.log(` radius: ${capsule.radius}, length: ${capsule.length}, axis: Y`);

Extends

Properties

axis

axis: Axis

The axis along which the capsule extends.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Shape.id


length

length: number

The length of the capsule along its axis.


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

Shape.meta


radius

radius: number

The radius of the capsule.


type

readonly type: string

The entity's type.

Inherited from

Shape.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

Shape.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Shape.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

Shape.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Shape.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Shape.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Shape.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Shape.isSame