Class LocomotionProfileBuilder

Namespace

Trailblazer.Navigation.Motor

Assembly

Trailblazer.dll

Fluent builder for composing built-in locomotion profiles.

public sealed class LocomotionProfileBuilder

Inheritance

object

LocomotionProfileBuilder

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LocomotionProfileBuilder(bool)

Initializes a new builder.

public LocomotionProfileBuilder(bool includeOptionalLocomotions = true)

Parameters

includeOptionalLocomotions bool

When true, seeds the builder with the default full locomotion profile.

Properties

Climb

The optional climb locomotion to install.

public ClimbLocomotion? Climb { get; }

Property Value

ClimbLocomotion

Fall

The fall locomotion to install.

public FallLocomotion Fall { get; }

Property Value

FallLocomotion

Fly

The optional fly locomotion to install.

public FlyLocomotion? Fly { get; }

Property Value

FlyLocomotion

Jump

The optional jump locomotion to install.

public JumpLocomotion? Jump { get; }

Property Value

JumpLocomotion

Move

The move locomotion to install.

public MoveLocomotion Move { get; }

Property Value

MoveLocomotion

Platform

The required platform locomotion to install.

public PlatformLocomotion Platform { get; }

Property Value

PlatformLocomotion

Slide

The optional slide locomotion to install.

public SlideLocomotion? Slide { get; }

Property Value

SlideLocomotion

Water

The optional water locomotion to install.

public WaterLocomotion? Water { get; }

Property Value

WaterLocomotion

Methods

Build()

Builds the composed locomotion profile.

public LocomotionProfile Build()

Returns

LocomotionProfile

WithClimb(ClimbLocomotion?)

Installs or replaces climb locomotion.

public LocomotionProfileBuilder WithClimb(ClimbLocomotion? climb = null)

Parameters

climb ClimbLocomotion

Returns

LocomotionProfileBuilder

WithFall(FallLocomotion)

Replaces the core fall locomotion.

public LocomotionProfileBuilder WithFall(FallLocomotion fall)

Parameters

fall FallLocomotion

Returns

LocomotionProfileBuilder

WithFly(FlyLocomotion?)

Installs or replaces fly locomotion.

public LocomotionProfileBuilder WithFly(FlyLocomotion? fly = null)

Parameters

fly FlyLocomotion

Returns

LocomotionProfileBuilder

WithJump(JumpLocomotion?)

Installs or replaces jump locomotion.

public LocomotionProfileBuilder WithJump(JumpLocomotion? jump = null)

Parameters

jump JumpLocomotion

Returns

LocomotionProfileBuilder

WithMove(MoveLocomotion)

Replaces the core move locomotion.

public LocomotionProfileBuilder WithMove(MoveLocomotion move)

Parameters

move MoveLocomotion

Returns

LocomotionProfileBuilder

WithPlatform(PlatformLocomotion?)

Installs or replaces platform locomotion.

public LocomotionProfileBuilder WithPlatform(PlatformLocomotion? platform = null)

Parameters

platform PlatformLocomotion

Returns

LocomotionProfileBuilder

WithSlide(SlideLocomotion?)

Installs or replaces slide locomotion.

public LocomotionProfileBuilder WithSlide(SlideLocomotion? slide = null)

Parameters

slide SlideLocomotion

Returns

LocomotionProfileBuilder

WithWater(WaterLocomotion?)

Installs or replaces water locomotion.

public LocomotionProfileBuilder WithWater(WaterLocomotion? water = null)

Parameters

water WaterLocomotion

Returns

LocomotionProfileBuilder

WithoutClimb()

Removes climb locomotion.

public LocomotionProfileBuilder WithoutClimb()

Returns

LocomotionProfileBuilder

WithoutFly()

Removes fly locomotion.

public LocomotionProfileBuilder WithoutFly()

Returns

LocomotionProfileBuilder

WithoutJump()

Removes jump locomotion.

public LocomotionProfileBuilder WithoutJump()

Returns

LocomotionProfileBuilder

WithoutSlide()

Removes slide locomotion.

public LocomotionProfileBuilder WithoutSlide()

Returns

LocomotionProfileBuilder

WithoutWater()

Removes water locomotion.

public LocomotionProfileBuilder WithoutWater()

Returns

LocomotionProfileBuilder