Table of Contents

Class BVCDParser

Namespace
ValveResourceFormat.ResourceTypes.Choreo.Parser
Assembly
ValveResourceFormat.dll

Parser for binary VCD (BVCD) choreography scene files.

public class BVCDParser

Inheritance

Inherited Members

Fields

MAGIC

Magic number for BVCD files ("bvcd").

public const int MAGIC = 1684239970

Field Value

int

Methods

Parse(Stream, string[])

Parses a BVCD choreography scene from a stream.

public static ChoreoScene Parse(Stream stream, string[] strings)

Parameters

stream Stream

The stream containing BVCD data.

strings string[]

The string table for the BVCD file.

Returns

ChoreoScene

The parsed choreography scene.

Read()

Reads and parses the choreography scene from the stream.

protected virtual ChoreoScene Read()

Returns

ChoreoScene

The parsed choreography scene.

ReadAbsoluteTag()

Reads an absolute tag from the stream.

protected virtual ChoreoTag ReadAbsoluteTag()

Returns

ChoreoTag

The parsed absolute tag.

ReadActor()

Reads an actor from the stream.

protected virtual ChoreoActor ReadActor()

Returns

ChoreoActor

The parsed actor.

ReadChannel()

Reads a channel from the stream.

protected virtual ChoreoChannel ReadChannel()

Returns

ChoreoChannel

The parsed channel.

ReadCurveData()

Reads curve data from the stream.

protected virtual ChoreoCurveData ReadCurveData()

Returns

ChoreoCurveData

The parsed curve data.

ReadEdge()

Reads a curve edge from the stream.

protected virtual ChoreoEdge ReadEdge()

Returns

ChoreoEdge

The parsed edge, or null if no edge exists.

ReadEvent()

Reads an event from the stream.

protected virtual ChoreoEvent ReadEvent()

Returns

ChoreoEvent

The parsed event.

ReadFlex()

Reads flex animation data from the stream.

protected virtual ChoreoEventFlex ReadFlex()

Returns

ChoreoEventFlex

The parsed event flex data.

ReadFlexTrack()

Reads a flex animation track from the stream.

protected virtual ChoreoFlexAnimationTrack ReadFlexTrack()

Returns

ChoreoFlexAnimationTrack

The parsed flex animation track.

ReadRelativeTag()

Reads a relative tag from the stream.

protected virtual ChoreoEventRelativeTag ReadRelativeTag()

Returns

ChoreoEventRelativeTag

The parsed relative tag.

ReadSample()

Reads a sample point from the stream.

protected virtual ChoreoSample ReadSample()

Returns

ChoreoSample

The parsed sample.

ReadString()

Reads a string from the string table.

protected string ReadString()

Returns

string

The string at the current index.

ReadStringIndex()

Reads a string index from the stream.

protected virtual int ReadStringIndex()

Returns

int

The string index.

ReadTag()

Reads a tag from the stream.

protected virtual ChoreoTag ReadTag()

Returns

ChoreoTag

The parsed tag.

RemapEventType(byte)

Remaps a byte value to the corresponding choreography event type.

protected ChoreoEventType RemapEventType(byte eventValue)

Parameters

eventValue byte

The byte value representing the event type.

Returns

ChoreoEventType

The corresponding choreography event type.