TGE Script Documentation

by Ron Yacketta · in General Discussion · 04/04/2002 (6:34 am) · 86 replies · 1

OpenALInitDriver()
	Initializes the sound driver
	Returns a "BOOL"

OpenALShutdownDriver()
	Disables the sound driver
	Returns a "void"

OpenALRegisterExtensions()
	This appears to be a stub function call into the OpenAL interface
	Returns a "void"

alGetString(enum)
	Used to return the name for the enum passed
	Returns a "const char*"
		  echo("   Vendor: " @ alGetString("AL_VENDOR"));
alxCreateSource(profile,{x,y,z}|description,filename,{x,y,z})
Creates and validates the Audio source (sound file) and readies it to be played

alxSourcef(handle,ALenum,value)
	Used to set the value (a float) of ALenum for the specified handle
	Returns a "void"
	            alxSourcef($ClientChatHandle[%sender], "AL_PITCH", %pitch);
alxSource3f(handle,ALenum,\"xyz\"|x,y,z)
	Sets up a loop playback 
	Returns a "void"

alxSourcei(handle, ALenum, value)
	Used to set the value (a int) of ALenum for the specified handle
	Returns a "void"

alxGetSourcef(handle,Alenum)
	Used to get the value (float) of ALenum for the specified Audio Handle
	Reruns a "float"

alxGetSource3f(handle, ALenum)
	Used to get the value (3 float's) of ALenum for the specified Audio Handle\
	Returns a "float" in the form of "x y z"

alxGetSourcei(handle, ALenum)
	Used to get the value (int) of ALenum for the specified Audio Handle
	Reruns a "int"

alxPlay(handle) | alxPlay(profile) | alxPlay(profile, x,y,z)
	Used to begin audio playback on specified (Handle | profile | profile "x y z")
	Returns a "int"

alxStop(handle)
	Used to stop the audio playback on specified Handle
	Returns a "void"

AlxStopAll()
	Used to stop ALL Audio playback on all registered sound channels
	Returns a "void"
alxIsPlaying(handle)
	Used to determine if a Handle is currently performing audio playback
	Returns a "BOOL"

alxListener(ALenum,value)
Used to set the ALenum extension supporting linear gain to value (float)
Returns a "void"

alListener3f(ALenum,\"xyz\"|x,y,z)
	Used to set the ALenum extension supporting linear gain to value (passed 3 floats "x y z")
	Returns a "void"

alxGetListenerf(ALenum)
	Returns the linear gain value of ALenum as a single float

AlxGetListener3f(ALenum)
	Returns the linear gain value of ALenum as three floats (x y z)

alxGetListeneri(ALenum)
	Returns the linear gain value of ALenum as a int

alxGetChannelVolume(channel_id)
	Returns the current volume of specified channel as a int

alxSetChannelVolume(channel_id)
	Used to set the volume of the specified channel.
	Returns a "BOOL"

DumpConsoleClasses()
Used to dump All registered console classes to the console in native C++ syntax
Returns a "void"

ExpandFilename(filename)
	Used to determine the actual path of the specified filename
	Returns a "const char*"

strcmp(one,two)
	Used to compare two strings. 
	Returns 0 if they are equal, nonzero if they are different.

stricmp(one,two)
Compares, with case insensitivity, the string pointed to by "one" to the string pointed to by "two".
Returns
< 0 
"one" is less than "two". 
0 
"one" is equal to "two". 
> 0 
"one" is greater than "two"

strlen(str)
	Returns the length of "str" as a int
strstr(string,substr)
	locate first occurrence of a "substr" within a "string"
	returns a "char *"

strpos(stringhay,stringneedle[,intoffset])
	Returns the numeric position of the first occurrence of "stringneedle" in the "stringhay"

ltrim(str)
	Strip white space from the beginning of a "str"

rtrim(str)
	Strip white space from the end of a "str"

trim(str)
	Strip leading and trailing white space of a "str"

sripChars(string,chars)
	Used to remove "chars" from "string" returning the result

srlwr(string)
	Replaces each character of a "string" with its lowercase equivalent.

srupr(string)
	Replaces each character of a "string" with its uppercase equivalent.

strchr(string,char)
ruturns the first occurrence of "char" in "string"

strreplace(string,from,to)
Searches the entire "string" for the occurrences of "fromt" and replaces with "to".

getSubStr(string,start,numChars)
Returns the sub string of "string", starting at "start", and continuing to either the end of the string, or "numChars" characters, whichever comes first.

getWord(text,index)
	Returns the word at specified at index within "text", returns a "const char *"

getWords(text,index [,entindex])
	Returns the word(s) specified at index [,entindex] within "text", returns a "const char *"	

setWord(text,index,replace)"
	Replaces word at index with "replace" within "text", returns a 'const char *"

removeWord(text,index)
	Remove word at index from "text", returns a "const char *"

getWordCount(text)
	Return the number of words within "text", returns a "const char *"

getField(text,index)
	Return the "const char*" at index within "text"

getFields(text,index [,entindex])
	Returns the field(s) specified at index [,entindex] within "text", returns a "const char *"	

setField(text,index,replace)"
	Replace field at "index" with "replace", returns a "const char *"

removeField(text,index)
	Remove field at "index" from "text", returns a "const char*"

getFieldCount(text)
	Returns the number of fields within "text", returns a "int"

getRecord(text,index)
	Return the record at "index" within "text", returns a "const char *"

getRecords(text,index[,endIndex])
	Return the record(s) at "index [,endIndex]" within "text", returns a "const char *"

setRecord(text,index,replace)
	Replace record at "index" with "replace" within "text", returns a "const char *"

removeRecord(text,index)
	Remove record at "index" within "text", returns a "const char *"

getRecordCount(text)
	Return the number of records within "text", returns a "int"

firstWord(text)
	Returns the first word within "text", returns a "const char *"

restWords(text)
	Returns the remaining words in "text", returns a "const char *"

detag(textTagString)
	Returns a string with its "tag" removed.

Game Development Community

TGE Script Documentation

About the author

Recent Threads