Class ChoreoEvent

Namespace

ValveResourceFormat.ResourceTypes.Choreo

Assembly

ValveResourceFormat.dll

Represents an event in a choreography scene.

public class ChoreoEvent

Inheritance

object

ChoreoEvent

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Properties

ClosedCaptionsToken

Gets the closed captions token.

public string ClosedCaptionsToken { get; init; }

Property Value

string

ClosedCaptionsType

Gets the closed captions type.

public ChoreoClosedCaptionsType ClosedCaptionsType { get; init; }

Property Value

ChoreoClosedCaptionsType

ConstrainedEventId

Gets the constrained event ID.

public int ConstrainedEventId { get; init; }

Property Value

int

DistanceToTarget

Gets the distance to target.

public float DistanceToTarget { get; init; }

Property Value

float

EndTime

Gets the end time of the event.

public float EndTime { get; init; }

Property Value

float

EventFlex

Gets the event flex data.

public ChoreoEventFlex EventFlex { get; init; }

Property Value

ChoreoEventFlex

Flags

Gets the flags for the event.

public ChoreoFlags Flags { get; init; }

Property Value

ChoreoFlags

FlexTimingTags

Gets the flex timing tags for the event.

public ChoreoTag[] FlexTimingTags { get; init; }

Property Value

ChoreoTag[]

Id

Gets the ID of the event.

public int Id { get; init; }

Property Value

int

LoopCount

Gets the loop count for the event.

public byte LoopCount { get; init; }

Property Value

byte

Name

Gets the name of the event.

public string Name { get; init; }

Property Value

string

Param1

Gets the first parameter of the event.

public string Param1 { get; init; }

Property Value

string

Param2

Gets the second parameter of the event.

public string Param2 { get; init; }

Property Value

string

Param3

Gets the third parameter of the event.

public string Param3 { get; init; }

Property Value

string

PlaybackTimeTags

Gets the playback time tags for the event.

public ChoreoTag[] PlaybackTimeTags { get; init; }

Property Value

ChoreoTag[]

PreferredName

Gets the preferred name of the event.

public string PreferredName { get; init; }

Property Value

string

Ramp

Gets the ramp curve data for the event.

public ChoreoCurveData Ramp { get; init; }

Property Value

ChoreoCurveData

RelativeTag

Gets the relative tag for the event.

public ChoreoEventRelativeTag RelativeTag { get; init; }

Property Value

ChoreoEventRelativeTag

RelativeTags

Gets the relative tags for the event.

public ChoreoTag[] RelativeTags { get; init; }

Property Value

ChoreoTag[]

SequenceDuration

Gets the sequence duration.

public float SequenceDuration { get; init; }

Property Value

float

ShiftedTimeTags

Gets the shifted time tags for the event.

public ChoreoTag[] ShiftedTimeTags { get; init; }

Property Value

ChoreoTag[]

SoundStartDelay

Gets the sound start delay.

public float SoundStartDelay { get; init; }

Property Value

float

SpeakFlags

Gets the speak flags for the event.

public ChoreoSpeakFlags SpeakFlags { get; init; }

Property Value

ChoreoSpeakFlags

StartTime

Gets the start time of the event.

public float StartTime { get; init; }

Property Value

float

Type

Gets the type of the event.

public ChoreoEventType Type { get; init; }

Property Value

ChoreoEventType

Methods

ToKeyValues()

Converts this event to a ValveResourceFormat.Serialization.KeyValues.KVObject.

public KVObject ToKeyValues()

Returns

KVObject

A ValveResourceFormat.Serialization.KeyValues.KVObject representing this event.