Editor.Components.Physics.Capsule
ClassA capsule-shaped physics collider.
Index
Properties
Methods
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
readonlyid:Uuid
The unique id of the entity.
Inherited from
length
length:
number
The length of the capsule along its axis.
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
radius
radius:
number
The radius of the capsule.
type
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
Shape.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean