C# Class Files.AudioLogic.HitVM

Show file Open project: Afr0Games/Project-Dollhouse Class Usage Examples

Public Properties

Property Type Description
Events RegisteredEvent>.Dictionary
IsInitialized bool

Private Properties

Property Type Description
RegisterEvent void

Public Methods

Method Description
GetGlobalVar ( int Location ) : int

Reads a global variable.

HitVM ( string StartupDir ) : System
KillTrack ( uint TrackID ) : void

Kills a track with the given ID.

PlayEvent ( string Event ) : void

Plays a track for a registered event.

PlayTrack ( uint TrackID ) : void

Starts playing a track with the given ID.

SetGlobalVar ( int Location, int Value ) : void

Sets a global variable to a value.

Step ( ) : void

Runs one instruction for each track that is currently playing.

Private Methods

Method Description
RegisterEvent ( HitResourcegroup RscGroup ) : void

Registers all the events in a resource group.

Method Details

GetGlobalVar() public static method

Reads a global variable.
public static GetGlobalVar ( int Location ) : int
Location int The location to read from.
return int

HitVM() public method

public HitVM ( string StartupDir ) : System
StartupDir string
return System

KillTrack() public static method

Kills a track with the given ID.
public static KillTrack ( uint TrackID ) : void
TrackID uint ID of the track to kill.
return void

PlayEvent() public static method

Plays a track for a registered event.
public static PlayEvent ( string Event ) : void
Event string The name of the registered event to play.
return void

PlayTrack() public static method

Starts playing a track with the given ID.
public static PlayTrack ( uint TrackID ) : void
TrackID uint ID of the track to play.
return void

SetGlobalVar() public static method

Sets a global variable to a value.
public static SetGlobalVar ( int Location, int Value ) : void
Location int The location of the global variable to set.
Value int The value to set the variable to.
return void

Step() public static method

Runs one instruction for each track that is currently playing.
public static Step ( ) : void
return void

Property Details

Events public static property

All playable events registered by the VM.
public static Dictionary Events
return RegisteredEvent>.Dictionary

IsInitialized public static property

public static bool IsInitialized
return bool