Class InputBufferConsumedEvent

Published via the Scylla Event eXchange System (SEX) when a buffered input entry is retrieved and consumed by a game system, removing it from the buffer.

Inheritance

object

ScyllaEvent

InputBufferConsumedEvent

Inherited Members

ScyllaEvent.IsCancelled

ScyllaEvent.StopPropagation()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Scylla.Input

Assembly: ScyllaInput.dll

Syntax

public class InputBufferConsumedEvent : ScyllaEvent

Remarks

Subscribe via ScyllaEvents.Listen<InputBufferConsumedEvent>. The Age property can be used to determine how long the input sat in the buffer before it was consumed; inputs that are too old may be discarded rather than consumed depending on the game's buffering settings.

Properties

ActionID

Gets or sets the string identifier of the action whose buffered input was consumed.

Declaration

public string ActionID { get; set; }

Property Value

Type	Description
string

Age

Gets or sets the elapsed time in seconds between when the input was buffered and when it was consumed. A large value indicates the input was held in the buffer for an extended period, which may indicate the consuming system was unavailable or occupied for longer than expected.

Declaration

public float Age { get; set; }

Property Value

Type	Description
float

Value

Gets or sets the scalar float value of the input that was consumed, as it was recorded at the time of buffering.

Declaration

public float Value { get; set; }

Property Value

Type	Description
float

See Also

InputBufferedEvent