Class AirshipNetworkBehaviourAbstract

A TypeScript parallel to the C# NetworkBehaviour for Airship.

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

This component REQUIRES a NetworkObject in the same game object or in the parent of the heirachy

Example declaration:

export default class ExampleBehaviour extends AirshipNetworkBehaviour {
    public OnClientStart() {
        print("Hello, World! from the client!");
    }
    public OnServerStart() {
        print("Hello, World! from the server!");
    }

Hierarchy (view full)

Constructors

constructor

Properties

gameObject networkIdentity transform

Accessors

enabled

Methods

Awake FixedUpdate? GetPlayerOwner IsOwned LateUpdate? OnCollisionEnter? OnCollisionEnter2D? OnCollisionExit? OnCollisionExit2D? OnCollisionStay? OnCollisionStay2D? OnDestroy OnDisable? OnEnable? OnStartAuthority? OnStartClient? OnStartServer? OnStopAuthority? OnStopClient? OnStopServer? OnTriggerEnter? OnTriggerEnter2D? OnTriggerExit? OnTriggerExit2D? OnTriggerStay? OnTriggerStay2D? Start? Update?

Constructors

Protected constructor

  • new AirshipNetworkBehaviour(): AirshipNetworkBehaviour

  • 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 AirshipNetworkBehaviour

    Deprecated

Properties

Readonly gameObject

gameObject: GameObject

The GameObject this behaviour is attached to.

networkIdentity

networkIdentity: NetworkIdentity

The NetworkObject this behaviour is attached to

Readonly transform

transform: Transform

The Transform this behaviour is attached to.

Accessors

enabled

  • get enabled(): boolean

  • The enabled state of this component

    Returns boolean

Methods

Protected Awake

Protected Optional FixedUpdate

  • FixedUpdate(dt): void

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

    Parameters

    • dt: number

    Returns void

GetPlayerOwner

  • GetPlayerOwner(): undefined | Player

  • Gets the player who owns this object (if applicable)

    • Will return undefined if the object is server-owned or the owner is no longer in the server
    • If you want to verify the owner isn't the server, use IsServerOwned. or if the caller is the owner IsOwned

    Returns undefined | Player

IsOwned

  • IsOwned(): boolean

  • Returns true if the caller is the owner of this object

    Returns boolean

Protected Optional LateUpdate

  • LateUpdate(dt): void

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

    Parameters

    • dt: number

    Returns void

Protected Optional OnCollisionEnter

Protected Optional OnCollisionEnter2D

Protected Optional OnCollisionExit

Protected Optional OnCollisionExit2D

Protected Optional OnCollisionStay

Protected Optional OnCollisionStay2D

Protected OnDestroy

Protected Optional OnDisable

  • OnDisable(): void

  • This function is called when the behaviour becomes disabled.

    Returns void

Protected Optional OnEnable

  • OnEnable(): void

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

    Returns void

Protected Optional OnStartAuthority

  • OnStartAuthority(): void

  • Like Start(), but only called for objects the client has authority over.

    Returns void

Protected Optional OnStartClient

  • OnStartClient(): void

  • Like Start(), but only called on client and host.

    Returns void

Protected Optional OnStartServer

  • OnStartServer(): void

  • Like Start(), but only called on server and host.

    Returns void

Protected Optional OnStopAuthority

  • OnStopAuthority(): void

  • Stop event, only called for objects the client has authority over.

    Returns void

Protected Optional OnStopClient

  • OnStopClient(): void

  • Stop event, only called on client and host.

    Returns void

Protected Optional OnStopServer

  • OnStopServer(): void

  • Stop event, only called on server and host.

    Returns void

Protected Optional OnTriggerEnter

Protected Optional OnTriggerEnter2D

Protected Optional OnTriggerExit

Protected Optional OnTriggerExit2D

Protected Optional OnTriggerStay

Protected Optional OnTriggerStay2D

Protected Optional 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

Protected Optional 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

constructorgameObjectnetworkIdentitytransformenabledAwakeFixedUpdateGetPlayerOwnerIsOwnedLateUpdateOnCollisionEnterOnCollisionEnter2DOnCollisionExitOnCollisionExit2DOnCollisionStayOnCollisionStay2DOnDestroyOnDisableOnEnableOnStartAuthorityOnStartClientOnStartServerOnStopAuthorityOnStopClientOnStopServerOnTriggerEnterOnTriggerEnter2DOnTriggerExitOnTriggerExit2DOnTriggerStayOnTriggerStay2DStartUpdate