Table of Contents

Class ChoreoScene

Namespace
ValveResourceFormat.ResourceTypes.Choreo
Assembly
ValveResourceFormat.dll

Represents a choreography scene.

public class ChoreoScene

Inheritance

Inherited Members

Constructors

ChoreoScene(byte, ChoreoEvent[], ChoreoActor[], ChoreoCurveData, bool)

Initializes a new instance of the ValveResourceFormat.ResourceTypes.Choreo.ChoreoScene class.

public ChoreoScene(byte version, ChoreoEvent[] events, ChoreoActor[] actors, ChoreoCurveData ramp, bool ignorePhonemes)

Parameters

version byte

The choreography format version.

events ChoreoEvent[]

The events in this scene.

actors ChoreoActor[]

The actors in this scene.

ramp ChoreoCurveData

The scene ramp curve data.

ignorePhonemes bool

Whether to ignore phonemes.

Properties

Actors

Gets the actors in this scene.

public ChoreoActor[] Actors { get; }

Property Value

ChoreoActor[]

Duration

Gets or sets the duration of the scene. This comes from outside of the BVCD data.

public int Duration { get; set; }

Property Value

int

Events

Gets the events in this scene.

public ChoreoEvent[] Events { get; }

Property Value

ChoreoEvent[]

HasSounds

Gets or sets a value indicating whether the scene has sounds. This comes from outside of the BVCD data.

public bool HasSounds { get; set; }

Property Value

bool

IgnorePhonemes

Gets a value indicating whether phonemes should be ignored.

public bool IgnorePhonemes { get; }

Property Value

bool

Name

Gets or sets the name of the scene. This comes from outside of the BVCD data.

public string Name { get; set; }

Property Value

string

Ramp

Gets the scene ramp curve data.

public ChoreoCurveData Ramp { get; }

Property Value

ChoreoCurveData

SoundDuration

Gets or sets the sound duration. This comes from outside of the BVCD data.

public int SoundDuration { get; set; }

Property Value

int

Version

Gets the version of the choreography format.

public byte Version { get; }

Property Value

byte

Methods

ToKeyValues()

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

public KVObject ToKeyValues()

Returns

KVObject

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