Class CharacterConfigSetup

Use to configure basic properties of Airship character system.

Usage: add this component to any game object in your scene.

Hierarchy (view full)

AirshipBehaviour
- CharacterConfigSetup

Constructors

`Protected` constructor

new CharacterConfigSetup(): CharacterConfigSetup

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 CharacterConfigSetup

Deprecated

Properties

`Optional` customCharacterPrefab

customCharacterPrefab?: GameObject

Must include a Character component. Make sure this prefab is also assigned in the Resources/NetworkPrefabCollection.asset

`Readonly` gameObject

gameObject: GameObject

The GameObject this behaviour is attached to.

`Readonly` transform

transform: Transform

The Transform this behaviour is attached to.

Methods

FixedUpdate

FixedUpdate(dt): void
Frame-rate independent AirshipBehaviour.FixedUpdate message for physics calculations.
Parameters
- dt: number
Returns void
Inherited from AirshipBehaviour.FixedUpdate

LateUpdate

LateUpdate(dt): void
LateUpdate is called every frame, if the AirshipBehaviour is enabled.
Parameters
- dt: number
Returns void
Inherited from AirshipBehaviour.LateUpdate

OnCollisionEnter

OnCollisionEnter(collision): void
Called when this collider/rigidbody starts touching another collider/rigidbody.
Parameters
- collision: Collision
  Collision data.
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnCollisionEnter.html

Inherited from AirshipBehaviour.OnCollisionEnter

OnCollisionEnter2D

OnCollisionEnter2D(collision2D): void
Called when this collider/rigidbody starts touching another collider/rigidbody.
Parameters
- collision2D: Collision2D
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnCollisionEnter2D.html

Inherited from AirshipBehaviour.OnCollisionEnter2D

OnCollisionExit

OnCollisionExit(collision): void
Called when this collider/rigidbody stops touching another collider/rigidbody.
Parameters
- collision: Collision
  Collision data.
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnCollisionExit.html

Inherited from AirshipBehaviour.OnCollisionExit

OnCollisionExit2D

OnCollisionExit2D(collision2D): void
Called when this collider/rigidbody stops touching another collider/rigidbody.
Parameters
- collision2D: Collision2D
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnCollisionExit2D.html

Inherited from AirshipBehaviour.OnCollisionExit2D

OnCollisionStay

OnCollisionStay(collision): void
Called once per frame while this collider/rigidbody is touching another collider/rigidbody.
Parameters
- collision: Collision
  Collision data.
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnCollisionStay.html

Inherited from AirshipBehaviour.OnCollisionStay

OnCollisionStay2D

OnCollisionStay2D(collision2D): void
Called once per frame while this collider/rigidbody is touching another collider/rigidbody.
Parameters
- collision2D: Collision2D
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnCollisionStay2D.html

Inherited from AirshipBehaviour.OnCollisionStay2D

OnDestroy

OnDestroy(): void
Destroying the attached Behaviour will result in the game or Scene receiving OnDestroy.

Returns void
Inherited from AirshipBehaviour.OnDestroy

OnDisable

OnDisable(): void
This function is called when the behaviour becomes disabled.

Returns void
Inherited from AirshipBehaviour.OnDisable

OnTriggerEnter

OnTriggerEnter(collider): void
Called when this collider/rigidbody starts touching another collider/rigidbody.
Parameters
- collider: Collider
  Collider.
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnTriggerEnter.html

Inherited from AirshipBehaviour.OnTriggerEnter

OnTriggerEnter2D

OnTriggerEnter2D(collider2D): void
Called when this collider/rigidbody starts touching another collider/rigidbody.
Parameters
- collider2D: Collider2D
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnTriggerEnter2D.html

Inherited from AirshipBehaviour.OnTriggerEnter2D

OnTriggerExit

OnTriggerExit(collider): void
Called when this collider/rigidbody stops touching another collider/rigidbody.
Parameters
- collider: Collider
  Collider.
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnTriggerExit.html

Inherited from AirshipBehaviour.OnTriggerExit

OnTriggerExit2D

OnTriggerExit2D(collider2D): void
Called when this collider/rigidbody stops touching another collider/rigidbody.
Parameters
- collider2D: Collider2D
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnTriggerExit2D.html

Inherited from AirshipBehaviour.OnTriggerExit2D

OnTriggerStay

OnTriggerStay(collider): void
Called once per frame while this collider/rigidbody is touching another collider/rigidbody.
Parameters
- collider: Collider
  Collider.
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnTriggerStay.html

Inherited from AirshipBehaviour.OnTriggerStay

OnTriggerStay2D

OnTriggerStay2D(collider2D): void
Called once per frame while this collider/rigidbody is touching another collider/rigidbody.
Parameters
- collider2D: Collider2D
Returns void
See
https://docs.unity3d.com/ScriptReference/Collider.OnTriggerStay2D.html

Inherited from AirshipBehaviour.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
Inherited from AirshipBehaviour.Start

Update

Update(dt): void
Update is called every frame, if the AirshipBehaviour is enabled.
Parameters
- dt: number
Returns void
Inherited from AirshipBehaviour.Update

Class CharacterConfigSetup

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Use Awake instead of overloading the constructor!

Returns CharacterConfigSetup

Deprecated

Properties

Optional customCharacterPrefab

Readonly gameObject

Readonly transform

Methods

FixedUpdate

Parameters

Returns void

LateUpdate

Parameters

Returns void

OnCollisionEnter

Parameters

Returns void

See

OnCollisionEnter2D

Parameters

Returns void

See

OnCollisionExit

Parameters

Returns void

See

OnCollisionExit2D

Parameters

Returns void

See

OnCollisionStay

Parameters

Returns void

See

OnCollisionStay2D

Parameters

Returns void

See

OnDestroy

Returns void

OnDisable

Returns void

OnTriggerEnter

Parameters

Returns void

See

OnTriggerEnter2D

Parameters

Returns void

See

OnTriggerExit

Parameters

Returns void

See

OnTriggerExit2D

Parameters

Returns void

See

OnTriggerStay

Parameters

Returns void

See

OnTriggerStay2D

Parameters

Returns void

See

Start

Returns void

Update

Parameters

Returns void

Settings

`Protected` constructor

`Optional` customCharacterPrefab

`Readonly` gameObject

`Readonly` transform