Interface ComponentHost

What a component sees of its host. @fourjs/scene's Node satisfies this structurally; so does ComponentRegistry itself.

interface ComponentHost {
    addComponent<T extends Component>(component: T): T;
    getComponent<T extends Component>(type: ComponentType<T>): T | undefined;
    removeComponent(component: Component): boolean;
}

Implemented by

Index

Methods

addComponent getComponent removeComponent

Methods

addComponent

addComponent<T extends Component>(component: T): T
Type Parameters
- T extends Component
Parameters
- component: T
Returns T
- Defined in packages/core/src/component.ts:29

getComponent

getComponent<T extends Component>(type: ComponentType<T>): T | undefined
Type Parameters
- T extends Component
Parameters
- type: ComponentType<T>
Returns T | undefined
- Defined in packages/core/src/component.ts:30

removeComponent

removeComponent(component: Component): boolean
Parameters
- component: Component
Returns boolean
- Defined in packages/core/src/component.ts:31