Class AirshipSingletonAbstract

A TypeScript parallel to a component Singleton for Airship - no boilerplate required

  • To expose the serializable properties to the inspector, it must be exported as default.

Example declaration:

export default class ExampleSingleton extends AirshipSingleton {
    public PrintHelloWorld() {
        print("Hello, World!");
    }
}

The singleton can then be retrieved via 

import ExampleSingleton from "./ExampleSingleton";
export default class SomeRequiringComponent extends AirshipBehaviour {
        public Start() {
            const exampleSingleton = ExampleSingleton.Get();
            exampleSingleton.PrintHelloWorld();
        }
}

Hierarchy (view full)

Constructors

constructor

Properties

gameObject transform

Methods

Awake FixedUpdate Get LateUpdate OnCollisionEnter OnCollisionEnter2D OnCollisionExit OnCollisionExit2D OnCollisionStay OnCollisionStay2D OnDestroy OnDisable OnEnable OnTriggerEnter OnTriggerEnter2D OnTriggerExit OnTriggerExit2D OnTriggerStay OnTriggerStay2D Start Update

Constructors

Protected constructor

  • new AirshipSingleton(): AirshipSingleton

  • Use Awake instead of overloading the constructor!

    • You can specify non-optional properties using the null-assertion operator - !
    export default class ExampleBehaviour extends AirshipBehaviour {
        textComponent!: TMP_Text;
        Awake() {
            this.textComponent = this.gameObject.GetComponent<TMP_Text>();
        }
    }

    Returns AirshipSingleton

    Deprecated

Properties

Readonly gameObject

gameObject: GameObject

The GameObject this behaviour is attached to.

Readonly transform

transform: Transform

The Transform this behaviour is attached to.

Methods

Awake

  • Awake(): void

  • Awake is called when an enabled script instance is being loaded.

    Returns void

FixedUpdate

  • FixedUpdate(dt): void

  • Frame-rate independent AirshipBehaviour.FixedUpdate message for physics calculations.

    Parameters

    • dt: number

    Returns void

Static Get

  • Get<TThis>(this): TThis["prototype"]

  • Resolves a single instance of this Singleton object statically

    Type Parameters

    • TThis

    Parameters

    Returns TThis["prototype"]

LateUpdate

  • LateUpdate(dt): void

  • LateUpdate is called every frame, if the AirshipBehaviour is enabled.

    Parameters

    • dt: number

    Returns void

OnCollisionEnter

OnCollisionEnter2D

OnCollisionExit

OnCollisionExit2D

OnCollisionStay

OnCollisionStay2D

OnDestroy

  • OnDestroy(): void

  • Destroying the attached Behaviour will result in the game or Scene receiving OnDestroy.

    Returns void

OnDisable

  • OnDisable(): void

  • This function is called when the behaviour becomes disabled.

    Returns void

OnEnable

  • OnEnable(): void

  • This function is called when the object becomes enabled and active.

    Returns void

OnTriggerEnter

OnTriggerEnter2D

OnTriggerExit

OnTriggerExit2D

OnTriggerStay

OnTriggerStay2D

Start

  • Start(): void

  • OnStart is called on the frame when a script is enabled just before any of the Update methods are called the first time.

    Returns void

Update

  • Update(dt): void

  • Update is called every frame, if the AirshipBehaviour is enabled.

    Parameters

    • dt: number

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorgameObjecttransformAwakeFixedUpdateGetLateUpdateOnCollisionEnterOnCollisionEnter2DOnCollisionExitOnCollisionExit2DOnCollisionStayOnCollisionStay2DOnDestroyOnDisableOnEnableOnTriggerEnterOnTriggerEnter2DOnTriggerExitOnTriggerExit2DOnTriggerStayOnTriggerStay2DStartUpdate