Class FlyLocomotion

Namespace

Trailblazer.Navigation.Motor

Assembly

Trailblazer.dll

Handles controlled flight movement while the scout is airborne.

public class FlyLocomotion : ILocomotion, ITransient, IRecordable

Inheritance

object

FlyLocomotion

Implements

ILocomotion

ITransient

IRecordable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ITransientExtensions.ClearTransientState(ITransient)

ITransientExtensions.SyncTransientState(ITransient, ITransient)

Remarks

Flight is distinct from both jumping and falling. It provides active air control, optional gravity cancellation, and controlled ascent or descent.

Constructors

FlyLocomotion()

public FlyLocomotion()

Fields

CanFly

Determines whether the scout is allowed to enter controlled flight.

public bool CanFly

Field Value

bool

DefaultGravityCompensation

Default amount of gravity canceled while actively flying.

public static readonly Fixed64 DefaultGravityCompensation

Field Value

Fixed64

DefaultMaxAscendSpeed

Default maximum upward flight speed.

public static readonly Fixed64 DefaultMaxAscendSpeed

Field Value

Fixed64

DefaultMaxDescendSpeed

Default maximum downward flight speed while actively descending.

public static readonly Fixed64 DefaultMaxDescendSpeed

Field Value

Fixed64

DefaultMaxFlyAcceleration

Default acceleration used while actively flying.

public static readonly Fixed64 DefaultMaxFlyAcceleration

Field Value

Fixed64

DefaultMaxFlySpeed

Default maximum horizontal flight speed.

public static readonly Fixed64 DefaultMaxFlySpeed

Field Value

Fixed64

GravityCompensation

The amount of gravity canceled while flying, clamped between 0 and 1 by the motor.

public Fixed64 GravityCompensation

Field Value

Fixed64

MaxAscendSpeed

The maximum upward speed while flying.

public Fixed64 MaxAscendSpeed

Field Value

Fixed64

MaxDescendSpeed

The maximum downward speed while actively descending under flight control.

public Fixed64 MaxDescendSpeed

Field Value

Fixed64

MaxFlyAcceleration

The maximum acceleration applied while steering in flight.

public Fixed64 MaxFlyAcceleration

Field Value

Fixed64

MaxFlySpeed

The maximum horizontal speed while flying.

public Fixed64 MaxFlySpeed

Field Value

Fixed64

Properties

IsEnabled

Indicates whether this locomotion behavior is enabled. If disabled, its movement effects will not be applied.

public bool IsEnabled { get; set; }

Property Value

bool

IsFlying

Indicates whether controlled flight is currently active.

[Transient]
public bool IsFlying { get; set; }

Property Value

bool

Methods

RecordData(IChronicler)

Records the current instance state to the provided chronicler.

public void RecordData(IChronicler chronicler)

Parameters

chronicler IChronicler

The active chronicler pass.