Skip to main content

Editor.Components.Physics.ColliderComponent

Class

Defines collision geometry and physics properties for an object.

Index

Example

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

const obj = scene.createSceneObject('PhysicsCollider');
const collider = obj.addComponent('ColliderComponent') as Editor.Components.Physics.ColliderComponent;

collider.debugDrawEnabled = true;
collider.fitVisual = true;
collider.intangible = false;
collider.smooth = false;
console.log(`ColliderComponent: debug=${collider.debugDrawEnabled}, fitVisual=${collider.fitVisual}, intangible=${collider.intangible}, smooth=${collider.smooth}`);

Extends

Extended by

Properties

debugDrawEnabled

debugDrawEnabled: boolean

Enable visual debugging of the collider shape.


enabled

enabled: boolean

Whether the component is active.

Inherited from

Component.enabled


excludeFromParentCompounding

excludeFromParentCompounding: boolean

If enabled, this collider is never merged into an ancestor's compound shape and is simulated as its own top-level collider. It can still compound its own children.


filter

filter: Filter

Collision filtering rules for this collider.


fitVisual

fitVisual: boolean

Automatically match collider shape to visual bounds.


forceCompound

forceCompound: boolean

Force collision shape to use compound geometry.


hasPrefabChanges

readonly hasPrefabChanges: boolean

Whether this entity differs from its counterpart in the prefab or was added to the prefab instance. Always false outside prefab instances.

Inherited from

Component.hasPrefabChanges


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Component.id


intangible

intangible: boolean

Disable collision response while maintaining overlap detection.


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

Component.isPrefabInstanceRoot


matter

matter: Matter

Physics material properties for this collider.


meta

readonly meta: Meta

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

Inherited from

Component.meta


name

name: string

Name of the component.

Inherited from

Component.name


overlapFilter

overlapFilter: Filter

Filtering rules for overlap queries on this collider.


rotateSmoothFactor

rotateSmoothFactor: number

Damping factor for rotational motion.


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

Component.sceneObject


shape

shape: Shape

Collision shape definition.


smooth

smooth: boolean

Enable motion smoothing between physics updates.


translateSmoothFactor

translateSmoothFactor: number

Damping factor for translational motion.


type

readonly type: string

The entity's type.

Inherited from

Component.type


worldSettings

worldSettings: WorldSettingsAsset

Physics simulation settings for this collider's world.

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Component.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Component.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Component.getOwnedEntities


getPrefabInstanceRoot()

getPrefabInstanceRoot(): Prefabable

Returns the nearest prefab instance root that contains this entity, starting with the entity itself, or null if it is not part of a prefab instance.

Returns

Prefabable

Inherited from

Component.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Component.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Component.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Component.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

Component.isSame