Struct PluginProjectilePathResult

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The answer to one projectile-path query.

public readonly record struct PluginProjectilePathResult : IEquatable<PluginProjectilePathResult>

Implements

IEquatable<PluginProjectilePathResult>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginProjectilePathResult(PluginProjectilePathStatus, int, uint, string?)

The answer to one projectile-path query.

public PluginProjectilePathResult(PluginProjectilePathStatus Status, int CollisionChecks = 0, uint BlockingObjectId = 0, string? Notice = null)

Parameters

Status PluginProjectilePathStatus

Whether the shot was admitted, and if not, why not.

CollisionChecks int

How many collision steps the query actually performed.

BlockingObjectId uint

The object that stopped the shot, or the target's own id when the flight ended on the target. Zero when the landscape stopped it or nothing did.

Notice string

A short explanation for a budget or error result; null otherwise.

Properties

BlockingObjectId

The object that stopped the shot, or the target's own id when the flight ended on the target. Zero when the landscape stopped it or nothing did.

public uint BlockingObjectId { get; init; }

Property Value

uint

CollisionChecks

How many collision steps the query actually performed.

public int CollisionChecks { get; init; }

Property Value

int

DebugSamples

The per-step markers of the simulated flight. Empty unless the query was made through the diagnostics overload.

public IReadOnlyList<PluginProjectileDebugSample> DebugSamples { get; init; }

Property Value

IReadOnlyList<PluginProjectileDebugSample>

IsClear

True only when the status is Clear.

public bool IsClear { get; }

Property Value

bool

Notice

A short explanation for a budget or error result; null otherwise.

public string? Notice { get; init; }

Property Value

string

Status

Whether the shot was admitted, and if not, why not.

public PluginProjectilePathStatus Status { get; init; }

Property Value

PluginProjectilePathStatus