C# Class FSO.HIT.HITInterpreter

Public Properties

Property	Type	Description
Instructions	HITInstruction[]

Public Methods

Method	Description
Abs ( HITThread thread ) : HITResult
Add ( HITThread thread ) : HITResult	Increment a "dest" variable by a "src" variable.
AddToGroup ( HITThread thread ) : HITResult
And ( HITThread thread ) : HITResult
Assert ( HITThread thread ) : HITResult
Call ( HITThread thread ) : HITResult	Call a function; push the instruction pointer and jump to the given address.
CallEntryPoint ( HITThread thread ) : HITResult
CallMask ( HITThread thread ) : HITResult
CallPush ( HITThread thread ) : HITResult
Callback ( HITThread thread ) : HITResult
Cmp ( HITThread thread ) : HITResult	Compare two variables and set the flags.
Dec ( HITThread thread ) : HITResult
Div ( HITThread thread ) : HITResult	Divide a "dest" variable by a "src" variable, and round the result towards zero (truncate).
Duck ( HITThread thread ) : HITResult	Ducks all audio with priority lower than this. Imagine all the other sounds getting quieter when the fire music plays.
End ( HITThread thread ) : HITResult	Return from this function; pop the instruction pointer from the stack and jump.
Error ( HITThread thread ) : HITResult
GetSrcDataField ( HITThread thread ) : HITResult
GetVar ( HITThread thread ) : HITResult
Greater ( HITThread thread ) : HITResult
IfEqual ( HITThread thread ) : HITResult	If the zero flag is set, jump to the given address.
IfGreatOrEq ( HITThread thread ) : HITResult	If the sign flag is not set, jump to the given address.
IfGreater ( HITThread thread ) : HITResult	If the sign flag is not set and the zero flag is not set, jump to the given address
IfLess ( HITThread thread ) : HITResult	If the sign flag is set, jump to the given address.
IfLessOrEq ( HITThread thread ) : HITResult	If the sign flag is set or the zero flag is set, jump to the given address.
IfNotEqual ( HITThread thread ) : HITResult	If the zero flag is not set, jump to the given address.
Inc ( HITThread thread ) : HITResult
Jump ( HITThread thread ) : HITResult	Jump to a given address.
KillNote ( HITThread thread ) : HITResult
KillTrack ( HITThread thread ) : HITResult	Kill a track, whose ID resides in the specified variable.
Less ( HITThread thread ) : HITResult
Limit ( HITThread thread ) : HITResult
LoadB ( HITThread thread ) : HITResult	Sign-extend a 1-byte constant to 4 bytes and write to a variable.
LoadL ( HITThread thread ) : HITResult	Write a 4-byte constant to a variable.
Loop ( HITThread thread ) : HITResult	Jump back to the loop point (start of track subroutine by default).
Max ( HITThread thread ) : HITResult	Find the higher of a "dest" variable and a "src" constant and store the result in the variable.
Min ( HITThread thread ) : HITResult	Find the lower of a "dest" variable and a "src" constant and store the result in the variable.
Mul ( HITThread thread ) : HITResult	Multiply a "dest" variable by a "src" variable.
NAnd ( HITThread thread ) : HITResult
NOP ( HITThread thread ) : HITResult	Does nothing.
NOr ( HITThread thread ) : HITResult
Not ( HITThread thread ) : HITResult
Note ( HITThread thread ) : HITResult
NoteOff ( HITThread thread ) : HITResult
NoteOn ( HITThread thread ) : HITResult	Play a note, whose ID resides in the specified variable.
NoteOnLoop ( HITThread thread ) : HITResult
Or ( HITThread thread ) : HITResult
PlayNote ( HITThread thread ) : HITResult
PlayTrack ( HITThread thread ) : HITResult	Play a track, whose ID resides in the specified variable.
Pop ( HITThread thread ) : HITResult
PrintReg ( HITThread thread ) : HITResult
Push ( HITThread thread ) : HITResult
PushMask ( HITThread thread ) : HITResult
PushVars ( HITThread thread ) : HITResult
Rand ( HITThread thread ) : HITResult	Generate a random number between "low" and "high" variables, inclusive, and store the result in the "dest" variable.
RemoveFromGroup ( HITThread thread ) : HITResult
Return ( HITThread thread ) : HITResult	Kill this thread.
SeqGroupKill ( HITThread thread ) : HITResult	Kill an actor's vocals, given a constant ID.
SeqGroupReturn ( HITThread thread ) : HITResult	Kill a sequence group with the return value specified by a constant.
SeqGroupTrackID ( HITThread thread ) : HITResult
SeqGroupWait ( HITThread thread ) : HITResult
Set ( HITThread thread ) : HITResult	Copy the contents of one variable into another.
SetChanReg ( HITThread thread ) : HITResult
SetGL ( HITThread thread ) : HITResult	Read globally, set locally (source: defaultsyms.txt).
SetLG ( HITThread thread ) : HITResult	Set global = local (source: defaultsyms.txt).
SetLL ( HITThread thread ) : HITResult	Copy the contents of one variable into another (equivalent to set and settt; defaultsyms.txt says "ISN'T THIS THE SAME AS SET TOO?")
SetLT ( HITThread thread ) : HITResult
SetLoop ( HITThread thread ) : HITResult	Set the loop point to the current position.
SetSrcDataField ( HITThread thread ) : HITResult
SetTL ( HITThread thread ) : HITResult
SmartAdd ( HITThread thread ) : HITResult
SmartChoose ( HITThread thread ) : HITResult	Set the specified variable to a random entry from the selected hitlist.
SmartIndex ( HITThread thread ) : HITResult	Load a track ("index" variable) from a hitlist ("table" variable).
SmartRemove ( HITThread thread ) : HITResult
SmartRemoveAll ( HITThread thread ) : HITResult
SmartSetCrit ( HITThread thread ) : HITResult
SmartSetList ( HITThread thread ) : HITResult	Choose a global hitlist, or 0 for the one local to the track (source: defaultsyms.txt).
StopNote ( HITThread thread ) : HITResult
StopTrack ( HITThread thread ) : HITResult	Stop playing a track, whose ID resides in the specified variable.
Sub ( HITThread thread ) : HITResult	Decrement a "dest" variable by a "src" variable.
Test ( HITThread thread ) : HITResult	Examine a variable and set the flags.
Test1 ( HITThread thread ) : HITResult
Test2 ( HITThread thread ) : HITResult
Test3 ( HITThread thread ) : HITResult
Test4 ( HITThread thread ) : HITResult
TestX ( HITThread thread ) : HITResult
Throw ( HITThread thread ) : HITResult
Unduck ( HITThread thread ) : HITResult	Unducks all audio back to the volume before Duck() was called.
Wait ( HITThread thread ) : HITResult	Wait for a length of time in milliseconds, specified by a variable.
WaitEqual ( HITThread thread ) : HITResult	Wait until two variables are equal.
WaitGreatOrEq ( HITThread thread ) : HITResult
WaitGreater ( HITThread thread ) : HITResult
WaitLess ( HITThread thread ) : HITResult
WaitLessOrEq ( HITThread thread ) : HITResult
WaitNotEqual ( HITThread thread ) : HITResult
WaitSamp ( HITThread thread ) : HITResult	Wait for the previously selected note to finish playing.
XOr ( HITThread thread ) : HITResult

Method Details

Abs() public static method

public static Abs ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Add() public static method

Increment a "dest" variable by a "src" variable.

public static Add ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

AddToGroup() public static method

public static AddToGroup ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

And() public static method

public static And ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Assert() public static method

public static Assert ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Call() public static method

Call a function; push the instruction pointer and jump to the given address.

public static Call ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

CallEntryPoint() public static method

public static CallEntryPoint ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

CallMask() public static method

public static CallMask ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

CallPush() public static method

public static CallPush ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Callback() public static method

public static Callback ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Cmp() public static method

Compare two variables and set the flags.

public static Cmp ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Dec() public static method

public static Dec ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Div() public static method

Divide a "dest" variable by a "src" variable, and round the result towards zero (truncate).

public static Div ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Duck() public static method

Ducks all audio with priority lower than this. Imagine all the other sounds getting quieter when the fire music plays.

public static Duck ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

End() public static method

Return from this function; pop the instruction pointer from the stack and jump.

public static End ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Error() public static method

public static Error ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

GetSrcDataField() public static method

public static GetSrcDataField ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

GetVar() public static method

public static GetVar ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Greater() public static method

public static Greater ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

IfEqual() public static method

If the zero flag is set, jump to the given address.

public static IfEqual ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

IfGreatOrEq() public static method

If the sign flag is not set, jump to the given address.

public static IfGreatOrEq ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

IfGreater() public static method

If the sign flag is not set and the zero flag is not set, jump to the given address

public static IfGreater ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

IfLess() public static method

If the sign flag is set, jump to the given address.

public static IfLess ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

IfLessOrEq() public static method

If the sign flag is set or the zero flag is set, jump to the given address.

public static IfLessOrEq ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

IfNotEqual() public static method

If the zero flag is not set, jump to the given address.

public static IfNotEqual ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Inc() public static method

public static Inc ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Jump() public static method

Jump to a given address.

public static Jump ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

KillNote() public static method

public static KillNote ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

KillTrack() public static method

Kill a track, whose ID resides in the specified variable.

public static KillTrack ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Less() public static method

public static Less ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Limit() public static method

public static Limit ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

LoadB() public static method

Sign-extend a 1-byte constant to 4 bytes and write to a variable.

public static LoadB ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

LoadL() public static method

Write a 4-byte constant to a variable.

public static LoadL ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Loop() public static method

Jump back to the loop point (start of track subroutine by default).

public static Loop ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Max() public static method

Find the higher of a "dest" variable and a "src" constant and store the result in the variable.

public static Max ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Min() public static method

Find the lower of a "dest" variable and a "src" constant and store the result in the variable.

public static Min ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Mul() public static method

Multiply a "dest" variable by a "src" variable.

public static Mul ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

NAnd() public static method

public static NAnd ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

NOP() public static method

Does nothing.

public static NOP ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

NOr() public static method

public static NOr ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Not() public static method

public static Not ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Note() public static method

public static Note ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

NoteOff() public static method

public static NoteOff ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

NoteOn() public static method

Play a note, whose ID resides in the specified variable.

public static NoteOn ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

NoteOnLoop() public static method

public static NoteOnLoop ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Or() public static method

public static Or ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

PlayNote() public static method

public static PlayNote ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

PlayTrack() public static method

Play a track, whose ID resides in the specified variable.

public static PlayTrack ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Pop() public static method

public static Pop ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

PrintReg() public static method

public static PrintReg ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Push() public static method

public static Push ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

PushMask() public static method

public static PushMask ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

PushVars() public static method

public static PushVars ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Rand() public static method

Generate a random number between "low" and "high" variables, inclusive, and store the result in the "dest" variable.

public static Rand ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

RemoveFromGroup() public static method

public static RemoveFromGroup ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Return() public static method

Kill this thread.

public static Return ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SeqGroupKill() public static method

Kill an actor's vocals, given a constant ID.

public static SeqGroupKill ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SeqGroupReturn() public static method

Kill a sequence group with the return value specified by a constant.

public static SeqGroupReturn ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SeqGroupTrackID() public static method

public static SeqGroupTrackID ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SeqGroupWait() public static method

public static SeqGroupWait ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Set() public static method

Copy the contents of one variable into another.

public static Set ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SetChanReg() public static method

public static SetChanReg ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SetGL() public static method

Read globally, set locally (source: defaultsyms.txt).

public static SetGL ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SetLG() public static method

Set global = local (source: defaultsyms.txt).

public static SetLG ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SetLL() public static method

Copy the contents of one variable into another (equivalent to set and settt; defaultsyms.txt says "ISN'T THIS THE SAME AS SET TOO?")

public static SetLL ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SetLT() public static method

public static SetLT ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SetLoop() public static method

Set the loop point to the current position.

public static SetLoop ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SetSrcDataField() public static method

public static SetSrcDataField ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SetTL() public static method

public static SetTL ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SmartAdd() public static method

public static SmartAdd ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SmartChoose() public static method

Set the specified variable to a random entry from the selected hitlist.

public static SmartChoose ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SmartIndex() public static method

Load a track ("index" variable) from a hitlist ("table" variable).

public static SmartIndex ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SmartRemove() public static method

public static SmartRemove ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SmartRemoveAll() public static method

public static SmartRemoveAll ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SmartSetCrit() public static method

public static SmartSetCrit ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

SmartSetList() public static method

Choose a global hitlist, or 0 for the one local to the track (source: defaultsyms.txt).

public static SmartSetList ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

StopNote() public static method

public static StopNote ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

StopTrack() public static method

Stop playing a track, whose ID resides in the specified variable.

public static StopTrack ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Sub() public static method

Decrement a "dest" variable by a "src" variable.

public static Sub ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Test() public static method

Examine a variable and set the flags.

public static Test ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Test1() public static method

public static Test1 ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Test2() public static method

public static Test2 ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Test3() public static method

public static Test3 ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Test4() public static method

public static Test4 ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

TestX() public static method

public static TestX ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Throw() public static method

public static Throw ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Unduck() public static method

Unducks all audio back to the volume before Duck() was called.

public static Unduck ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Wait() public static method

Wait for a length of time in milliseconds, specified by a variable.

public static Wait ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

WaitEqual() public static method

Wait until two variables are equal.

public static WaitEqual ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

WaitGreatOrEq() public static method

public static WaitGreatOrEq ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

WaitGreater() public static method

public static WaitGreater ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

WaitLess() public static method

public static WaitLess ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

WaitLessOrEq() public static method

public static WaitLessOrEq ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

WaitNotEqual() public static method

public static WaitNotEqual ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

WaitSamp() public static method

Wait for the previously selected note to finish playing.

public static WaitSamp ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

XOr() public static method

public static XOr ( HITThread thread ) : HITResult
thread	HITThread
return	HITResult

Property Details

Instructions public_oe static_oe property

public static HITInstruction[] Instructions
return	HITInstruction[]