Class InputBufferedEvent

Published via the Scylla Event eXchange System (SEX) when an input action's value is recorded into the input buffer for deferred consumption by game systems.

Inheritance

object

ScyllaEvent

InputBufferedEvent

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 InputBufferedEvent : ScyllaEvent

Remarks

The input buffer allows actions performed slightly before a system is ready to consume them (e.g., a jump button pressed one frame before the character lands) to still be registered. Subscribe via ScyllaEvents.Listen<InputBufferedEvent>.

When the buffered input is eventually consumed, InputBufferConsumedEvent will be published.

Properties

ActionID

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

Declaration

public string ActionID { get; set; }

Property Value

Type	Description
string

BufferCount

Gets or sets the total number of entries in the buffer for this action immediately after the new entry was added. A value greater than 1 indicates multiple rapid inputs have been queued for this action.

Declaration

public int BufferCount { get; set; }

Property Value

Type	Description
int

Timestamp

Gets or sets the Unity Input System timestamp (seconds) at which the input was recorded into the buffer. Used to compute the buffer entry's age when it is later consumed.

Declaration

public double Timestamp { get; set; }

Property Value

Type	Description
double

Value

Gets or sets the scalar float value of the input at the time it was buffered. For button actions this is typically 1.0.

Declaration

public float Value { get; set; }

Property Value

Type	Description
float

See Also

InputBufferConsumedEvent