Skip to main content

Editor.Assets.Physics.Filter

Class

Defines collision filtering rules for physics queries and interactions.

Index

Example

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

// Find existing Physics Filter assets (created alongside WorldSettingsAsset)
const filters = assetManager.assets.filter(a => a.isOfType('Filter'));
if (filters.length > 0) {
const filter = filters[0] as Editor.Assets.Physics.Filter;
filter.includeDynamic = true;
filter.includeStatic = false;
filter.includeIntangible = false;
console.log(`Filter "${filter.name}": dynamic=${filter.includeDynamic}, static=${filter.includeStatic}`);
} else {
console.log('No Physics Filter assets in project (add a WorldSettingsAsset first)');
}

Extends

Properties

cacheFile

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

Asset.cacheFile


fileMeta

readonly fileMeta: AssetImportMetadata

Import metadata for the asset.

Inherited from

Asset.fileMeta


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Asset.id


includeDynamic

includeDynamic: boolean

Include dynamic rigid bodies in physics queries.


includeIntangible

includeIntangible: boolean

Include intangible colliders in physics queries.


includeStatic

includeStatic: boolean

Include static rigid bodies in physics queries.


meta

readonly meta: Meta

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

Inherited from

Asset.meta


name

readonly name: string

The name of the asset.

Inherited from

Asset.name


onlyLayers

onlyLayers: LayerSet

Restrict queries to colliders on these layers only.


skipLayers

skipLayers: LayerSet

Exclude colliders on these layers from queries.


type

readonly type: string

The entity's type.

Inherited from

Asset.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Asset.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Asset.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Asset.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Asset.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

Asset.isSame