Struct PluginMovementIntent

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The movement keys a plugin wants held down. The host applies this as if the player were holding those keys, until it is replaced or cleared.

public readonly record struct PluginMovementIntent : IEquatable<PluginMovementIntent>

Implements

IEquatable<PluginMovementIntent>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginMovementIntent(bool, bool, bool, bool, bool, bool, bool, bool)

The movement keys a plugin wants held down. The host applies this as if the player were holding those keys, until it is replaced or cleared.

public PluginMovementIntent(bool Forward = false, bool Backward = false, bool StrafeLeft = false, bool StrafeRight = false, bool TurnLeft = false, bool TurnRight = false, bool Run = true, bool Jump = false)

Parameters

Forward bool

Hold the forward key.

Backward bool

Hold the backward key.

StrafeLeft bool

Sidestep to the left without turning.

StrafeRight bool

Sidestep to the right without turning.

TurnLeft bool

Turn on the spot to the left.

TurnRight bool

Turn on the spot to the right.

Run bool

Run rather than walk. Defaults to true.

Jump bool

Jump.

Properties

Backward

Hold the backward key.

public bool Backward { get; init; }

Property Value

bool

Forward

Hold the forward key.

public bool Forward { get; init; }

Property Value

bool

Jump

Jump.

public bool Jump { get; init; }

Property Value

bool

Run

Run rather than walk. Defaults to true.

public bool Run { get; init; }

Property Value

bool

StrafeLeft

Sidestep to the left without turning.

public bool StrafeLeft { get; init; }

Property Value

bool

StrafeRight

Sidestep to the right without turning.

public bool StrafeRight { get; init; }

Property Value

bool

TurnLeft

Turn on the spot to the left.

public bool TurnLeft { get; init; }

Property Value

bool

TurnRight

Turn on the spot to the right.

public bool TurnRight { get; init; }

Property Value

bool