the-world-engine/dist/esm/engine/script/render/ZaxisSorter.d.ts

three.js based, unity like game engine for browser

import { ZaxisSortable } from "./ZaxisSortable";
/**
 * Determine the z-value of the object based on the y-position of the gameObject
 *
 * This component is mainly used in top-down 2D games to control the rendering order of objects
 *
 * It applies to all renderers with child objects in the game object with this component
 */
export declare class ZaxisSorter extends ZaxisSortable {
    readonly disallowMultipleComponent: boolean;
    private _offset;
    private _runOnce;
    start(): void;
    update(): void;
    /**
     * The offset to be added to the z-position of the gameObject (default: 0)
     */
    get offset(): number;
    /**
     * The offset to be added to the z-position of the gameObject (default: 0)
     */
    set offset(value: number);
    /**
     * Whether to run this component only once at start (default: true)
     *
     * if gameObject is moveable, you should set this to false for update the z-axis
     */
    get runOnce(): boolean;
    /**
     * Whether to run this component only once at start (default: true)
     *
     * if gameObject is moveable, you should set this to false for update the z-axis
     */
    set runOnce(value: boolean);
}