@needle-tools/engine 3.28.6-beta → 3.28.7-beta.1

package/lib/engine-components/Component.d.ts

@@ -1,228 +1,228 @@
-/// <reference types="webxr" />
-import { Context, FrameEvent } from "../engine/engine_setup.js";
-import type { ConstructorConcrete, SourceIdentifier, IComponent, IGameObject, Constructor, GuidsMap, Collision, ICollider } from "../engine/engine_types.js";
-import { InstantiateOptions, HideFlags } from "../engine/engine_gameobject.js";
-import { Euler, Object3D, Quaternion, Scene, Vector3 } from "three";
-export declare abstract class GameObject extends Object3D implements Object3D, IGameObject {
-    guid: string | undefined;
-    abstract destroy(): any;
-    static isDestroyed(go: Object3D): boolean;
-    static setActive(go: Object3D, active: boolean, processStart?: boolean): void;
-    /** If the object is active (same as go.visible) */
-    static isActiveSelf(go: Object3D): boolean;
-    /** If the object is active in the hierarchy (e.g. if any parent is invisible or not in the scene it will be false)
-     * @param go object to check
-    */
-    static isActiveInHierarchy(go: Object3D): boolean;
-    static markAsInstancedRendered(go: Object3D, instanced: boolean): void;
-    static isUsingInstancing(instance: Object3D): boolean;
-    /** Run a callback for all components of the provided type on the provided object and its children (if recursive is true)
-     * @param instance object to run the method on
-     * @param cb callback to run on each component, "return undefined;" to continue and "return <anything>;" to break the loop
-     * @param recursive if true, the method will be run on all children as well
-     * @returns the last return value of the callback
-     */
-    static foreachComponent(instance: Object3D, cb: (comp: Component) => any, recursive?: boolean): any;
-    /** Creates a new instance of the provided object. The new instance will be created on all connected clients
-     * @param instance object to instantiate
-     * @param opts options for the instantiation
-     */
-    static instantiateSynced(instance: GameObject | Object3D | null, opts: InstantiateOptions): GameObject | null;
-    /** Creates a new instance of the provided object (like cloning it including all components and children)
-     * @param instance object to instantiate
-     * @param opts options for the instantiation (e.g. with what parent, position, etc.)
-    */
-    static instantiate(instance: GameObject | Object3D | null, opts?: InstantiateOptions | null): GameObject | null;
-    /** Destroys a object on all connected clients (if you are in a networked session)
-     * @param instance object to destroy
-    */
-    static destroySynced(instance: Object3D | Component, context?: Context, recursive?: boolean): void;
-    /** Destroys a object
-     * @param instance object to destroy
-     * @param recursive if true, all children will be destroyed as well. true by default
-     */
-    static destroy(instance: Object3D | Component, recursive?: boolean, isRoot?: boolean): void;
-    /**
-     * Add an object to parent and also ensure all components are being registered
-     */
-    static add(instance: Object3D | null | undefined, parent: Object3D, context?: Context): void;
-    /**
-     * Removes the object from its parent and deactivates all of its components
-     */
-    static remove(instance: Object3D | null | undefined): void;
-    /** Invokes a method on all components including children (if a method with that name exists) */
-    static invokeOnChildren(go: Object3D | null | undefined, functionName: string, ...args: any): void;
-    /** Invokes a method on all components that have a method matching the provided name
-     * @param go object to invoke the method on all components
-     * @param functionName name of the method to invoke
-     */
-    static invoke(go: Object3D | null | undefined, functionName: string, children?: boolean, ...args: any): void;
-    /**
-     * Adds a new component to the provided object
-     * @param go object to add the component to
-     * @param type type of the component to add
-     * @param callAwake if true, the component will be added and awake will be called immediately
-     */
-    static addNewComponent<T>(go: IGameObject | Object3D, type: ConstructorConcrete<T>, callAwake?: boolean): T;
-    /**
-     * Moves a component to a new object
-     * BEWARE: this does MOVE a component. If you want to add a new component use `addNewComponent`
-     * @param go component to move the component to
-     * @param instance component to move to the GO
-     */
-    static addComponent<T extends IComponent>(go: IGameObject | Object3D, instance: T | ConstructorConcrete<T>): IComponent;
-    /**
-     * Moves a component to a new object
-     * @param go component to move the component to
-     * @param instance component to move to the GO
-     */
-    static moveComponent<T extends IComponent>(go: IGameObject | Object3D, instance: T | ConstructorConcrete<T>): IComponent;
-    /** Removes a component from its object
-     * @param instance component to remove
-     */
-    static removeComponent<T extends IComponent>(instance: T): T;
-    static getOrAddComponent<T extends IComponent>(go: IGameObject | Object3D, typeName: ConstructorConcrete<T>): T;
-    /** Gets a component on the provided object */
-    static getComponent<T extends IComponent>(go: IGameObject | Object3D | null, typeName: Constructor<T> | null): T | null;
-    static getComponents<T extends IComponent>(go: IGameObject | Object3D | null, typeName: Constructor<T>, arr?: T[] | null): T[];
-    static findByGuid(guid: string, hierarchy: Object3D): GameObject | Component | null | undefined;
-    static findObjectOfType<T extends IComponent>(typeName: Constructor<T>, context?: Context | Object3D, includeInactive?: boolean): T | null;
-    static findObjectsOfType<T extends IComponent>(typeName: Constructor<T>, context?: Context | Object3D): Array<T>;
-    static getComponentInChildren<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>): T | null;
-    static getComponentsInChildren<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>, arr?: T[] | null): Array<T>;
-    static getComponentInParent<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>): T | null;
-    static getComponentsInParent<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>, arr?: Array<T> | null): Array<T>;
-    static getAllComponents(go: IGameObject | Object3D): Behaviour[];
-    static iterateComponents(go: IGameObject | Object3D): Generator<any, void, unknown>;
-    abstract activeSelf: boolean;
-    abstract get transform(): GameObject;
-    /** creates a new component on this gameObject */
-    abstract addNewComponent<T>(type: ConstructorConcrete<T>): T | null;
-    /** adds an existing component to this gameObject */
-    abstract addComponent<T extends IComponent>(comp: T | ConstructorConcrete<T>): void;
-    abstract removeComponent(comp: Component): Component;
-    abstract getOrAddComponent<T>(typeName: ConstructorConcrete<T> | null): T;
-    abstract getComponent<T>(type: Constructor<T>): T | null;
-    abstract getComponents<T>(type: Constructor<T>, arr?: T[]): Array<T>;
-    abstract getComponentInChildren<T>(type: Constructor<T>): T | null;
-    abstract getComponentsInChildren<T>(type: Constructor<T>, arr?: T[]): Array<T>;
-    abstract getComponentInParent<T>(type: Constructor<T>): T | null;
-    abstract getComponentsInParent<T>(type: Constructor<T>, arr?: T[]): Array<T>;
-    abstract get worldPosition(): Vector3;
-    abstract set worldPosition(val: Vector3);
-    abstract set worldQuaternion(val: Quaternion);
-    abstract get worldQuaternion(): Quaternion;
-    abstract set worldRotation(val: Vector3);
-    abstract get worldRotation(): Vector3;
-    abstract set worldScale(val: Vector3);
-    abstract get worldScale(): Vector3;
-    abstract get worldForward(): Vector3;
-    abstract get worldRight(): Vector3;
-    abstract get worldUp(): Vector3;
-}
-export declare class Component implements IComponent, EventTarget {
-    get isComponent(): boolean;
-    private __context;
-    get context(): Context;
-    set context(context: Context);
-    get scene(): Scene;
-    get layer(): number;
-    get name(): string;
-    private __name?;
-    set name(str: string);
-    get tag(): string;
-    set tag(str: string);
-    get static(): any;
-    get hideFlags(): HideFlags;
-    get activeAndEnabled(): boolean;
-    private get __isActive();
-    private get __isActiveInHierarchy();
-    private set __isActiveInHierarchy(value);
-    gameObject: GameObject;
-    guid: string;
-    sourceId?: SourceIdentifier;
-    /** called on a component with a map of old to new guids (e.g. when instantiate generated new guids and e.g. timeline track bindings needs to remape them) */
-    resolveGuids?(guidsMap: GuidsMap): void;
-    /** called once when the component becomes active for the first time */
-    awake(): void;
-    /** called every time when the component gets enabled (this is invoked after awake and before start) */
-    onEnable(): void;
-    onDisable(): void;
-    onDestroy(): void;
-    /** called when you decorate fields with the @validate() decorator
-     * @param field the name of the field that was changed
-     */
-    onValidate?(prop?: string): void;
-    /** Called for all scripts when the context gets paused or unpaused */
-    onPausedChanged?(isPaused: boolean, wasPaused: boolean): void;
-    start?(): void;
-    earlyUpdate?(): void;
-    update?(): void;
-    lateUpdate?(): void;
-    onBeforeRender?(frame: XRFrame | null): void;
-    onAfterRender?(): void;
-    onCollisionEnter?(col: Collision): any;
-    onCollisionExit?(col: Collision): any;
-    onCollisionStay?(col: Collision): any;
-    onTriggerEnter?(col: ICollider): any;
-    onTriggerStay?(col: ICollider): any;
-    onTriggerExit?(col: ICollider): any;
-    startCoroutine(routine: Generator, evt?: FrameEvent): Generator;
-    stopCoroutine(routine: Generator, evt?: FrameEvent): void;
-    get destroyed(): boolean;
-    destroy(): void;
-    /** @internal */
-    protected __didAwake: boolean;
-    /** @internal */
-    private __didStart;
-    /** @internal */
-    protected __didEnable: boolean;
-    /** @internal */
-    protected __isEnabled: boolean | undefined;
-    /** @internal */
-    private __destroyed;
-    /** @internal */
-    get __internalDidAwakeAndStart(): boolean;
-    /** @internal */
-    constructor();
-    /** @internal */
-    __internalNewInstanceCreated(): void;
-    /** @internal */
-    __internalAwake(): void;
-    /** @internal */
-    __internalStart(): void;
-    /** @internal */
-    __internalEnable(isAddingToScene?: boolean): boolean;
-    /** @internal */
-    __internalDisable(isRemovingFromScene?: boolean): void;
-    /** @internal */
-    __internalDestroy(): void;
-    get enabled(): boolean;
-    set enabled(val: boolean);
-    get worldPosition(): Vector3;
-    set worldPosition(val: Vector3);
-    setWorldPosition(x: number, y: number, z: number): void;
-    get worldQuaternion(): Quaternion;
-    set worldQuaternion(val: Quaternion);
-    setWorldQuaternion(x: number, y: number, z: number, w: number): void;
-    get worldEuler(): Euler;
-    set worldEuler(val: Euler);
-    get worldRotation(): Vector3;
-    set worldRotation(val: Vector3);
-    setWorldRotation(x: number, y: number, z: number, degrees?: boolean): void;
-    private static _forward;
-    /** Forward (0,0,-1) vector in world space */
-    get forward(): Vector3;
-    private static _right;
-    /** Right (1,0,0) vector in world space */
-    get right(): Vector3;
-    private static _up;
-    /** Up (0,1,0) vector in world space */
-    get up(): Vector3;
-    private _eventListeners;
-    addEventListener<T extends Event>(type: string, listener: (evt: T) => any): void;
-    removeEventListener<T extends Event>(type: string, listener: (arg: T) => any): void;
-    dispatchEvent(evt: Event): boolean;
-}
-export declare class Behaviour extends Component {
-}
+/// <reference types="webxr" />
+import { Context, FrameEvent } from "../engine/engine_setup.js";
+import type { ConstructorConcrete, SourceIdentifier, IComponent, IGameObject, Constructor, GuidsMap, Collision, ICollider } from "../engine/engine_types.js";
+import { InstantiateOptions, HideFlags } from "../engine/engine_gameobject.js";
+import { Euler, Object3D, Quaternion, Scene, Vector3 } from "three";
+export declare abstract class GameObject extends Object3D implements Object3D, IGameObject {
+    guid: string | undefined;
+    abstract destroy(): any;
+    static isDestroyed(go: Object3D): boolean;
+    static setActive(go: Object3D, active: boolean, processStart?: boolean): void;
+    /** If the object is active (same as go.visible) */
+    static isActiveSelf(go: Object3D): boolean;
+    /** If the object is active in the hierarchy (e.g. if any parent is invisible or not in the scene it will be false)
+     * @param go object to check
+    */
+    static isActiveInHierarchy(go: Object3D): boolean;
+    static markAsInstancedRendered(go: Object3D, instanced: boolean): void;
+    static isUsingInstancing(instance: Object3D): boolean;
+    /** Run a callback for all components of the provided type on the provided object and its children (if recursive is true)
+     * @param instance object to run the method on
+     * @param cb callback to run on each component, "return undefined;" to continue and "return <anything>;" to break the loop
+     * @param recursive if true, the method will be run on all children as well
+     * @returns the last return value of the callback
+     */
+    static foreachComponent(instance: Object3D, cb: (comp: Component) => any, recursive?: boolean): any;
+    /** Creates a new instance of the provided object. The new instance will be created on all connected clients
+     * @param instance object to instantiate
+     * @param opts options for the instantiation
+     */
+    static instantiateSynced(instance: GameObject | Object3D | null, opts: InstantiateOptions): GameObject | null;
+    /** Creates a new instance of the provided object (like cloning it including all components and children)
+     * @param instance object to instantiate
+     * @param opts options for the instantiation (e.g. with what parent, position, etc.)
+    */
+    static instantiate(instance: GameObject | Object3D | null, opts?: InstantiateOptions | null): GameObject | null;
+    /** Destroys a object on all connected clients (if you are in a networked session)
+     * @param instance object to destroy
+    */
+    static destroySynced(instance: Object3D | Component, context?: Context, recursive?: boolean): void;
+    /** Destroys a object
+     * @param instance object to destroy
+     * @param recursive if true, all children will be destroyed as well. true by default
+     */
+    static destroy(instance: Object3D | Component, recursive?: boolean, isRoot?: boolean): void;
+    /**
+     * Add an object to parent and also ensure all components are being registered
+     */
+    static add(instance: Object3D | null | undefined, parent: Object3D, context?: Context): void;
+    /**
+     * Removes the object from its parent and deactivates all of its components
+     */
+    static remove(instance: Object3D | null | undefined): void;
+    /** Invokes a method on all components including children (if a method with that name exists) */
+    static invokeOnChildren(go: Object3D | null | undefined, functionName: string, ...args: any): void;
+    /** Invokes a method on all components that have a method matching the provided name
+     * @param go object to invoke the method on all components
+     * @param functionName name of the method to invoke
+     */
+    static invoke(go: Object3D | null | undefined, functionName: string, children?: boolean, ...args: any): void;
+    /**
+     * Adds a new component to the provided object
+     * @param go object to add the component to
+     * @param type type of the component to add
+     * @param callAwake if true, the component will be added and awake will be called immediately
+     */
+    static addNewComponent<T>(go: IGameObject | Object3D, type: ConstructorConcrete<T>, callAwake?: boolean): T;
+    /**
+     * Moves a component to a new object
+     * BEWARE: this does MOVE a component. If you want to add a new component use `addNewComponent`
+     * @param go component to move the component to
+     * @param instance component to move to the GO
+     */
+    static addComponent<T extends IComponent>(go: IGameObject | Object3D, instance: T | ConstructorConcrete<T>): IComponent;
+    /**
+     * Moves a component to a new object
+     * @param go component to move the component to
+     * @param instance component to move to the GO
+     */
+    static moveComponent<T extends IComponent>(go: IGameObject | Object3D, instance: T | ConstructorConcrete<T>): IComponent;
+    /** Removes a component from its object
+     * @param instance component to remove
+     */
+    static removeComponent<T extends IComponent>(instance: T): T;
+    static getOrAddComponent<T extends IComponent>(go: IGameObject | Object3D, typeName: ConstructorConcrete<T>): T;
+    /** Gets a component on the provided object */
+    static getComponent<T extends IComponent>(go: IGameObject | Object3D | null, typeName: Constructor<T> | null): T | null;
+    static getComponents<T extends IComponent>(go: IGameObject | Object3D | null, typeName: Constructor<T>, arr?: T[] | null): T[];
+    static findByGuid(guid: string, hierarchy: Object3D): GameObject | Component | null | undefined;
+    static findObjectOfType<T extends IComponent>(typeName: Constructor<T>, context?: Context | Object3D, includeInactive?: boolean): T | null;
+    static findObjectsOfType<T extends IComponent>(typeName: Constructor<T>, context?: Context | Object3D): Array<T>;
+    static getComponentInChildren<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>): T | null;
+    static getComponentsInChildren<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>, arr?: T[] | null): Array<T>;
+    static getComponentInParent<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>): T | null;
+    static getComponentsInParent<T extends IComponent>(go: IGameObject | Object3D, typeName: Constructor<T>, arr?: Array<T> | null): Array<T>;
+    static getAllComponents(go: IGameObject | Object3D): Behaviour[];
+    static iterateComponents(go: IGameObject | Object3D): Generator<any, void, unknown>;
+    abstract activeSelf: boolean;
+    abstract get transform(): GameObject;
+    /** creates a new component on this gameObject */
+    abstract addNewComponent<T>(type: ConstructorConcrete<T>): T | null;
+    /** adds an existing component to this gameObject */
+    abstract addComponent<T extends IComponent>(comp: T | ConstructorConcrete<T>): void;
+    abstract removeComponent(comp: Component): Component;
+    abstract getOrAddComponent<T>(typeName: ConstructorConcrete<T> | null): T;
+    abstract getComponent<T>(type: Constructor<T>): T | null;
+    abstract getComponents<T>(type: Constructor<T>, arr?: T[]): Array<T>;
+    abstract getComponentInChildren<T>(type: Constructor<T>): T | null;
+    abstract getComponentsInChildren<T>(type: Constructor<T>, arr?: T[]): Array<T>;
+    abstract getComponentInParent<T>(type: Constructor<T>): T | null;
+    abstract getComponentsInParent<T>(type: Constructor<T>, arr?: T[]): Array<T>;
+    abstract get worldPosition(): Vector3;
+    abstract set worldPosition(val: Vector3);
+    abstract set worldQuaternion(val: Quaternion);
+    abstract get worldQuaternion(): Quaternion;
+    abstract set worldRotation(val: Vector3);
+    abstract get worldRotation(): Vector3;
+    abstract set worldScale(val: Vector3);
+    abstract get worldScale(): Vector3;
+    abstract get worldForward(): Vector3;
+    abstract get worldRight(): Vector3;
+    abstract get worldUp(): Vector3;
+}
+export declare class Component implements IComponent, EventTarget {
+    get isComponent(): boolean;
+    private __context;
+    get context(): Context;
+    set context(context: Context);
+    get scene(): Scene;
+    get layer(): number;
+    get name(): string;
+    private __name?;
+    set name(str: string);
+    get tag(): string;
+    set tag(str: string);
+    get static(): any;
+    get hideFlags(): HideFlags;
+    get activeAndEnabled(): boolean;
+    private get __isActive();
+    private get __isActiveInHierarchy();
+    private set __isActiveInHierarchy(value);
+    gameObject: GameObject;
+    guid: string;
+    sourceId?: SourceIdentifier;
+    /** called on a component with a map of old to new guids (e.g. when instantiate generated new guids and e.g. timeline track bindings needs to remape them) */
+    resolveGuids?(guidsMap: GuidsMap): void;
+    /** called once when the component becomes active for the first time */
+    awake(): void;
+    /** called every time when the component gets enabled (this is invoked after awake and before start) */
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
+    /** called when you decorate fields with the @validate() decorator
+     * @param field the name of the field that was changed
+     */
+    onValidate?(prop?: string): void;
+    /** Called for all scripts when the context gets paused or unpaused */
+    onPausedChanged?(isPaused: boolean, wasPaused: boolean): void;
+    start?(): void;
+    earlyUpdate?(): void;
+    update?(): void;
+    lateUpdate?(): void;
+    onBeforeRender?(frame: XRFrame | null): void;
+    onAfterRender?(): void;
+    onCollisionEnter?(col: Collision): any;
+    onCollisionExit?(col: Collision): any;
+    onCollisionStay?(col: Collision): any;
+    onTriggerEnter?(col: ICollider): any;
+    onTriggerStay?(col: ICollider): any;
+    onTriggerExit?(col: ICollider): any;
+    startCoroutine(routine: Generator, evt?: FrameEvent): Generator;
+    stopCoroutine(routine: Generator, evt?: FrameEvent): void;
+    get destroyed(): boolean;
+    destroy(): void;
+    /** @internal */
+    protected __didAwake: boolean;
+    /** @internal */
+    private __didStart;
+    /** @internal */
+    protected __didEnable: boolean;
+    /** @internal */
+    protected __isEnabled: boolean | undefined;
+    /** @internal */
+    private __destroyed;
+    /** @internal */
+    get __internalDidAwakeAndStart(): boolean;
+    /** @internal */
+    constructor();
+    /** @internal */
+    __internalNewInstanceCreated(): void;
+    /** @internal */
+    __internalAwake(): void;
+    /** @internal */
+    __internalStart(): void;
+    /** @internal */
+    __internalEnable(isAddingToScene?: boolean): boolean;
+    /** @internal */
+    __internalDisable(isRemovingFromScene?: boolean): void;
+    /** @internal */
+    __internalDestroy(): void;
+    get enabled(): boolean;
+    set enabled(val: boolean);
+    get worldPosition(): Vector3;
+    set worldPosition(val: Vector3);
+    setWorldPosition(x: number, y: number, z: number): void;
+    get worldQuaternion(): Quaternion;
+    set worldQuaternion(val: Quaternion);
+    setWorldQuaternion(x: number, y: number, z: number, w: number): void;
+    get worldEuler(): Euler;
+    set worldEuler(val: Euler);
+    get worldRotation(): Vector3;
+    set worldRotation(val: Vector3);
+    setWorldRotation(x: number, y: number, z: number, degrees?: boolean): void;
+    private static _forward;
+    /** Forward (0,0,-1) vector in world space */
+    get forward(): Vector3;
+    private static _right;
+    /** Right (1,0,0) vector in world space */
+    get right(): Vector3;
+    private static _up;
+    /** Up (0,1,0) vector in world space */
+    get up(): Vector3;
+    private _eventListeners;
+    addEventListener<T extends Event>(type: string, listener: (evt: T) => any): void;
+    removeEventListener<T extends Event>(type: string, listener: (arg: T) => any): void;
+    dispatchEvent(evt: Event): boolean;
+}
+export declare class Behaviour extends Component {
+}