mLog(x) | ||
---|---|---|
Parameters: | x | Radian. Can be an integer or a floating point. |
Return: | numeric | |
Description: | Computes the natural logarithm. | |
Usage: | %val = mLog(7654.98); |
mPow(x,y) | ||
---|---|---|
Parameters: | x | Base. Can be an integer or a floating point. |
y | Exponent. Can be an integer or a floating point. | |
Return: | numeric | |
Description: | Computes x raised to the power of y. | |
Usage: | %val = mPow(2,4); |
mRadToDeg(radians) | ||
---|---|---|
Parameters: | radians | Radians to be converted. Can be integers or floating points. |
Return: | numeric | |
Description: | Converts radians to degrees. | |
Usage: | %degs = mRadToDeg(1); |
msg(handle, message) | ||
---|---|---|
Parameters: | handle | Handle of object to receive message. |
message | String containing message. | |
Return: | nothing | |
Description: | Sends message to the object specified by handle. | |
Usage: | msg(%objhandle, %msg); |
mSin(x) | ||
---|---|---|
Parameters: | x | Radian. Can be an integer or a floating point. |
Return: | numeric | |
Description: | Computes the sine. | |
Usage: | %val = mSin(65); |
mSolveCubic(a,b,c,d) | ||
---|---|---|
Parameters: | a,b,c,d | Operands. Can be integers or floating points. |
Return: | string | |
Description: | Computes a cubic solution for x. ax⁁3 + bx⁁2 + cx + d = 0. | |
Usage: | %val = mSolveCubic(a,b,c,d); |
mSolveQuadratic(a,b,c) | ||
---|---|---|
Parameters: | a,b,c | Operands. Can be integers or floating points. |
Return: | string | |
Description: | Computes a quadratic solution for x. ax⁁2 + bx + c = 0. | |
Usage: | %val = mSolveQuadratic(a,b,c); |
mSolveQuartic(a,b,c,d,e) | ||
---|---|---|
Parameters: | a,b,c,d,e | Operands. Can be integers or floating points. |
Return: | string | |
Description: | Computes a quartic solution for x. ax⁁4 + bx⁁3 + cx⁁2 + dx + e = 0. | |
Usage: | %val = mSolveQuartic(a,b,c,d,e); |
mSqrt(x) | ||
---|---|---|
Parameters: | x | Operand. Can be an integer or a floating point. |
Return: | numeric | |
Description: | Computes the square root of x. | |
Usage: | %val = mSqrt(81); |
mTan(x) | ||
---|---|---|
Parameters: | x | Radian. Can be an integer or a floating point. |
Return: | numeric | |
Description: | Computes the tangent. | |
Usage: | %val = mTan(45.0); |
nameToID(name) | ||
---|---|---|
Parameters: | name | String containing the name of the object. |
Return: | nothing | |
Description: | Gets the ID number of the named object. | |
Usage: | nameToID(%chopper); |
nextResolution() | ||
---|---|---|
Parameters: | none | |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Increases next highest resolution. | |
Usage: | %result = nextResolution (); |
nextToken (str,token,delim) | ||
---|---|---|
Parameters: | str | Initializes tokenizer when set to a valid string variable. Uses an empty string ( " " ) to specify follow-up operation on the same string. |
token | Reference handle to the variable that will receive the found token. Note: When passing a variable by reference to a function, such as with this parameter, you do not prefix the variable name with % or $. | |
delim | Specifies the character that delimits the tokens. | |
Return: | string | Balance of the string after the found token. |
Description: | Sets token to the next substring in str delimited by delim. The initial call to this function specifies str; subsequent calls to this function that operate on the same string must pass the empty string ( " " ). | |
Usage: | %str = nextToken("one,two,three", number, ","); |
OpenALInitDriver() | |
---|---|
Parameters: | none |
Return: | numeric |
Description: | Initializes the sound driver. |
Usage: | OpenALInitDriver(); |
OpenALShutdownDriver() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Disables the sound driver. |
Usage: | OpenALShutdownDriver(); |
PanoramaScreenShot(filename) | ||
---|---|---|
Parameters: | filename | String containing file name. |
Return: | nothing | |
Description: | Captures the panoramic screen view and saves it to the file specified by filename. The engine will take the panoroma shot as a sequence of three screen captures, looking left, center, then right. | |
Usage: | PanoramaScreenShot("myPanorama"); |
pathOnMissionLoadDone() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Sets the Mod path that will be active when a mission is finished loading. |
Usage: | pathOnMissionLoadDone("missE/mission"); |
PermDisableMouse() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Permanently disables DirectInput polling of the mouse device. |
Usage: | PermDisableMouse(); |
PlayDemo(filename) | ||
---|---|---|
Parameters: | filename | String containing file name. |
Return: | nothing | |
Description: | Plays back a demo saved in filename. | |
Usage: | PlayDemo(MyNiftyDemo); |
PlayJournal(name,[break]) | ||
---|---|---|
Parameters: | name | String containing file name of journal. |
break | If true, then stops playback after each event. | |
Return: | nothing | |
Description: | Plays back saved journal specified by name. | |
Usage: | PlayJournal("myjrnl.jnl"); |
PrevResolution() | ||
---|---|---|
Parameters: | none | |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Decreases next highest resolution. | |
Usage: | %result = PrevResolution(); |
ProfilerDump() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Dumps NetStringTable statistics to the console. |
Usage: | ProfilerDump(); |
ProfilerDumpToFile(filename) | ||
---|---|---|
Parameters: | filename | String containing file name. |
Return: | nothing | |
Description: | Dumps NetStringTable statistics to the file specified by filename. | |
Usage: | ProfilerDumpToFile(dump.txt); |
ProfilerEnable(switch) | ||
---|---|---|
Parameters: | switch | 1 enables, 0 disables. |
Return: | nothing | |
Description: | Enables or disables profiling. | |
Usage: | ProfilerEnable(false); |
ProfilerMarkerEnable(markerName, switch) | ||
---|---|---|
Parameters: | markerName | Name of profile marker. |
switch | 1 enables, 0 disables. | |
Return: | nothing | |
Description: | Enables or disables profiling for markerName. | |
Usage: | ProfilerMarkerEnable(mark,true); |
PurgeResources() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Purges all resources used by the game through the resource manager. |
Usage: | PurgeResources(); |
QueryMasterServer (port,flags,gametype,missiontype,minplayers,maxplayers, maxbots,regionmask,maxping,filterflags,mincpu,buddycount,buddylist) | ||
---|---|---|
Parameters: | port | Master server port. |
flags | The query flags. Choices: | |
0x00 = online query | ||
0x01 = offline query | ||
0x02 = no string compression | ||
gametype | Game type string. | |
missiontype | Mission type string. | |
minplayers | Minimum number of players for viable game. | |
maxplayers | Maximum allowable players. | |
maxbots | Maximum allowable connected AI bots. | |
regionmask | Numeric discriminating mask. | |
maxping | Maximum ping for connecting clients; 0 means no maximum. | |
filterflags | Server filters. Choices: | |
0x00 = dedicated | ||
0x01 = not password protected | ||
0x02 = Linux | ||
0x80 = current version | ||
mincpu | Minimum specified CPU capability. | |
buddycount | Number of buddy servers in buddy list. | |
buddylist | List of server names that are buddies to this server. | |
Return: | nothing | |
Description: | Queries a master server looking for specified information. The responses are accessible from the ServerList array. | |
Usage: |
QueryMasterServer( 28000, 0, $Client::GameTypeQuery, Client::MissionTypeQuery, 0, 100, 0, 2, 0, 100, 0, 0, "" ); |
Quit() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Quits the game. |
Usage: | Quit(); |
RedbookClose() | ||
---|---|---|
Parameters: | none | |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Closes the currently open redbook (CD) device. | |
Usage: | %result = RedbookClose(); |
RedbookGetDeviceCount() | |
---|---|
Parameters: | none |
Return: | numeric |
Description: | Queries for the number of redbook (CD) devices. |
Usage: | %count = RedbookGetDeviceCount(); |
RedbookGetDeviceName(idx) | ||
---|---|---|
Parameters: | idx | Device index. |
Return: | string | |
Description: | Queries the device name of redbook (CD) at the specified device index. | |
Usage: | %name = RedbookGetDeviceName(1); |
RedbookGetLastError() | |
---|---|
Parameters: | none |
Return: | string |
Description: | Queries for the last error from a redbook (CD) device. |
Usage: | %error = RedbookGetLastError(); |
RedbookGetTrackCount() | |
---|---|
Parameters: | none |
Return: | numeric |
Description: | Queries the number of redbook (CD) tracks. |
Usage: | %tracks = RedbookGetTrackCount(); |
RedbookGetVolume() | |
---|---|
Parameters: | none |
Return: | numeric |
Description: | Queries the current volume level of a redbook (CD) device. |
Usage: | %volume = RedbookGetVolume(); |
RedbookOpen([name]) | ||
---|---|---|
Parameters: | name | If non-null, specifies the device. |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Opens a redbook (CD) device. | |
Usage: | %result = RedbookOpen(); |
RedbookPlay(track) | ||
---|---|---|
Parameters: | track | Index of track. |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Plays a track on a redbook (CD) device. | |
Usage: | %result = RedbookPlay(2); |
RedbookSetVolume(volume) | ||
---|---|---|
Parameters: | volume | Volume setting. |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Sets the volume of a redbook (CD) device. | |
Usage: | %result = RedbookSetVolume(%volume); |
RedbookStop() | ||
---|---|---|
Parameters: | none | |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Stops playing on the current redbook (CD) device. | |
Usage: | %result = RedbookStop(); |
RemoveField(text, index) | ||
---|---|---|
Parameters: | text | String with field-delimited words. |
index | Field-based offset into the text string. | |
Return: | string | The resultant string. |
Description: | Removes the field-string at index from text. | |
Usage: | %result = RemoveField(%text, 0); |
RemoveRecord (text, index) | ||
---|---|---|
Parameters: | text | String with new line-delimited records. |
index | Record-based offset into the text string. | |
Return: | string | The resultant string. |
Description: | Removes the record-string at index from text. | |
Usage: | %str = RemoveRecord(%text, 0); |
RemoveTaggedString(tag) | ||
---|---|---|
Parameters: | tag | Numeric tag of string to be removed. |
Return: | nothing | |
Description: | Removes a tagged string from the list. | |
Usage: | RemoveTaggedString(%tagname); |
RemoveWord(text, index) | ||
---|---|---|
Parameters: | text | String with space-delimited words. |
index | Word-based offset into the text string. | |
Return: | string | The resultant string. |
Description: | Removes the word-string at index from text. | |
Usage: | %str = RemoveWord(%text, 0); |
ResetLighting() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Resets the current lighting. |
Usage: | ResetLighting(); |
RestWords(text) | ||
---|---|---|
Parameters: | text | String with space-delimited words. |
Return: | string | The resultant string. |
Description: | Returns the words remaining after the first word in text. | |
Usage: | %data = RestWords(%text); |
Rtrim(str) | ||
---|---|---|
Parameters: | str | String to be processed. |
Return: | string | The processed resultant string. |
Description: | Strips any white space from str from the right side (after all other characters) of str. White space is defined as space, carriage returns, or new line characters. | |
Usage: | %tidystring = Rtrim(%yuckystring); |
SaveJournal(name) | ||
---|---|---|
Parameters: | name | String containing file name of journal. |
Return: | nothing | |
Description: | Save a journal to file specified by name. | |
Usage: | SaveJournal("myjrnl.jnl"); |
Schedule(time, reference, command, <arg1…argN>) | ||
---|---|---|
Parameters: | time | Time to wait for trigger, in milliseconds. |
reference | Handle of object to attach schedule to, or 0. | |
command | Command to execute. | |
arg1…argN | Arguments to accompany command. (optional) | |
Return: | numeric | Event ID. |
Description: | Schedules an event that will trigger in time milliseconds and execute command, with args. If reference is not 0, then it must be a valid object handle. If the object is deleted, the scheduled event is discarded. | |
Usage: | $evt = Schedule(5000, 0, "updateRadar"); |
ScreenShot(filename) | ||
---|---|---|
Parameters: | filename | String containing file name. |
Return: | nothing | |
Description: | Captures the screen view and saves it to file specified by filename. | |
Usage: | ScreenShot("myScreen"); |
SetDefaultFov( fov ) | ||
---|---|---|
Parameters: | fov | Numeric in degrees. |
Return: | nothing | |
Description: | Sets the default field of view. | |
Usage: | SetDefaultFov( 60 ); |
SetDisplayDevice(deviceName[, width[, height[, bpp[, fullScreen]]]] ) | ||
---|---|---|
Parameters: | devicename | Name of target device driver. |
width | Screen width. | |
height | Screen height. | |
bpp | Bits per pixel. | |
fullScreen | 1 enables, 0 disables. | |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Sets up the display device with specified values. | |
Usage: | %result = SetDisplayDevice ( "OpenGL", 800, 600, 32, true ); |
SetEchoFileLoads(switch) | ||
---|---|---|
Parameters: | switch | 1 (or true) enables, 0 (or false) disables. |
Return: | nothing | |
Description: | Enables or disables File Load echo to console. | |
Usage: | SetEchoFileLoads(1); |
SetField(text, index, subst) | ||
---|---|---|
Parameters: | text | String with field-delimited words. |
index | Field-based offset into the text string. | |
subst | Substitute string. | |
Return: | string | The resultant string. |
Description: | Substitutes the field-string sub for the word-string found at index in the string text. | |
Usage: | %rec = SetField(%text, 0, "blah"); |
SetFov(val) | ||
---|---|---|
Parameters: | val | The field of view (degrees). |
Return: | nothing | |
Description: | Sets the current field of view. | |
Usage: | SetFov(90); |
SetFSAA(switch, level) | ||
---|---|---|
Parameters: | switch | 1 enables, 0 disables. |
level | Target level. | |
Return: | nothing | |
Description: | Invokes SetNPatch with the same parameters. | |
Usage: | SetFSAA(%newstate,%lvl) |
SetInteriorFocusedDebug(which) | |
---|---|
Parameters: | which Handle of interior for focus. If which has a value, then debugging is enabled; if which is empty (not passed), then debugging is disabled. |
Return: | nothing |
Description: | Enables debug mode for interior focused objects. |
Usage: | SetInteriorFocusedDebug(); |
SetInteriorRenderMode(mode) | |
---|---|
Parameters: | mode |
Return: | nothing |
Description: | Sets the detail render level for interiors. |
Usage: | SetInteriorRenderMode(7); |
SetLogMode(mode) | ||
---|---|---|
Parameters: | mode | The numeric mode value. Choices: |
0 = no logging | ||
1 = logging on, append mode | ||
2 = logging on, overwrite mode | ||
Return: | nothing | |
Description: | Enables or disables error logging to disk. | |
Usage: | SetLogMode(1); |
SetModPaths(path) | ||
---|---|---|
Parameters: | path | String containing path. |
Return: | nothing | |
Description: | Set Mod path. This specifies which folders will be visible to the scripts and the resource engine. | |
Usage: | SetModPaths("common;game"); |
SetNetPort(port) | ||
---|---|---|
Parameters: | port | Port number. |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Sets the network port. | |
Usage: | %result = SetNetPort(1313); |
SetNPatch(switch, level) | ||
---|---|---|
Parameters: | switch | 1 enables, 0 disables. |
level | Target level. | |
Return: | nothing | |
Description: | Enables or disables Npatching (quadratic interpolation) at specified level. | |
Usage: | SetNPatch(1, 1); |
SetOpenGLAnisotropy(level) | ||
---|---|---|
Parameters: | level | 0=trilinear, 1=bilinear. |
Return: | nothing | |
Description: | Sets the level of anisotropy. | |
Usage: | SetOpenGLAnisotropy(0); |
SetOpenGLInteriorMipReduction(level) | ||
---|---|---|
Parameters: | level | Mipmap level (0 = minimum detail, 5 = maximum detail). |
Return: | nothing | |
Description: | Sets interior texture detail. | |
Usage: | SetOpenGLInteriorMipReduction(2); |
SetOpenGLMipReduction(level) | ||
---|---|---|
Parameters: | level | Mipmap level (0 = minimum detail, 5 = maximum detail). |
Return: | nothing | |
Description: | Sets shape texture detail to level. | |
Usage: | SetOpenGLMipReduction(2); |
SetOpenGLSkyMipReduction(level) | ||
---|---|---|
Parameters: | level | Mipmap level (0 = minimum detail, 5 = maximum detail). |
Return: | nothing | |
Description: | Sets skybox and cloud texture detail. | |
Usage: | SetOpenGLMipReduction(2); |
SetOpenGLTextureCompressionHint(hint) | ||
---|---|---|
Parameters: | hint | The compression level hint. Choices: |
Return: | nothing | |
Description: | Suggests texture compression mode. | |
Usage: | SetOpenGLTextureCompressionHint(GL_NICEST); |
SetRandomSeed([seed]) | ||
---|---|---|
Parameters: | seed | Starting point. |
Return: | nothing | |
Description: | Sets the current starting point for generating a series of pseudo-random numbers. | |
Usage: | SetRandomSeed(); |
SetRecord (text, index, subst) | ||
---|---|---|
Parameters: | text | String with new line-delimited records. |
index | Record-based offset into the text string. | |
subst | Substitute string. | |
Return: | string | The resultant string. |
Description: | Substitutes the record-string sub for the record-string found at index in the string text. | |
Usage: | %str = SetRecord(%text, 0, "blah"); |
SetResolution(width, height, bpp) | ||
---|---|---|
Parameters: | width | Screen width. |
height | Screen height. | |
bpp | Bits per pixel. | |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Sets the screen resolution to specified values. | |
Usage: | %result = SetResolution(640,480,32); |
SetScreenMode(width, height, bpp, fullScreen) | ||
---|---|---|
Parameters: | width | Screen width. |
height | Screen height. | |
bpp | Bits per pixel. | |
fullScreen | 1 enables, 0 disables. | |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Sets up the screen with specified values. | |
Usage: | %result = SetScreenMode( 800, 600, 32, true ); |
SetServerInfo(index) | ||
---|---|---|
Parameters: | index | Row of interest in the server list. |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Changes our indexed reference into the ServerList. | |
Usage: | %result = SetServerInfo(%index); |
SetShadowDetailLevel(level) | ||
---|---|---|
Parameters: | level | Numeric range 0.0 to 1.0. |
Return: | nothing | |
Description: | Sets the level of detail for shadows. | |
Usage: | SetShadowDetailLevel( 1.0 ); |
SetVerticalSync(switch) | ||
---|---|---|
Parameters: | switch | 1 enables, 0 disables. |
Return: | numeric | 1 = true, 0 = false. |
Description: | Enables or disables the use of VerticalSync. | |
Usage: | SetVerticalSync(true); |
SetWord(text, index, subst) | ||
---|---|---|
Parameters: | text | String with space-delimited words. |
index | Word-based offset into the text string. | |
subst | Substitute string. | |
Return: | string | The resultant string. |
Description: | Substitutes the word-string sub for the word-string found at index in the string text. | |
Usage: | %str = SetWord(%text, 0, "blah"); |
SetZoomSpeed( speed ) | ||
---|---|---|
Parameters: | speed | Transition speed. Ranges from 0 to 2,000 milliseconds. |
Return: | nothing | |
Description: | Sets the transition speed when changing field of view. | |
Usage: | SetZoomSpeed( speed ); |
StartHeartbeat() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Begins periodic messages to the master server that show that this server is still alive. |
Usage: | schedule(0,0,StartHeartbeat); |
StartRecording(filename) | ||
---|---|---|
Parameters: | filename | String containing file name. |
Return: | nothing | |
Description: | Records a demo and saves it as filename. | |
Usage: | StartRecording(myDemo); |
StopHeartbeat() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Stops the heartbeat messages. |
Usage: | StopHeartbeat(); |
StopRecording() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Stops the currently recording demo. |
Usage: | StopRecording(); |
StopServerQuery() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Cancels the current query and marks outstanding pings as finished. |
Usage: | StopServerQuery(); |
Strchr(str, char) | ||
---|---|---|
Parameters: | str | String to be processed. |
char | String containing the character to be found. | |
Return: | string | |
Description: | Finds the first substring in the string that begins with char. | |
Usage: | %file = Strchr("data/file.dat", "/" ); |
Strcmp(str1, str2) | |||
---|---|---|---|
Parameters: | str1 | First string. | |
str2 | Second string. | ||
Return: | numeric | < 0 | str1 is less than (also not equal to) str2. |
0 | str1 is equal to str2. | ||
> 0 | str1 is greater than (also not equal to) str2. | ||
Description: | Case-sensitive comparison of two strings: str1 and str2. | ||
Usage: |
if ( Strcmp( %weaponName, "candlestick" ) == 0 ) return %weaponFound; |
Stricmp(str1, str2) | |||
---|---|---|---|
Parameters: | str1 | First string. | |
str2 | Second string. | ||
Return: | numeric | < 0 | str1 is less than (not equal to) str2. |
0 | str1 is equal to str2. | ||
> 0 | str1 is greater than (not equal to) str2. | ||
Description: | Case-insensitive comparison of two strings: str1 and str2. | ||
Usage: |
if ( Stricmp(%weaponName, "CandleStick") == 0 ) return %weaponFound; |
StripChars(str, chars) | ||
---|---|---|
Parameters: | str | String to be processed. |
chars | String containing characters to be stripped. | |
Return: | string | The processed resultant string. |
Description: | Removes all characters in the string chars from the string str. | |
Usage: | %stripped = StripChars(%value, "~" ); |
StripMLControlChars(string) | |
---|---|
Parameters: | string |
Return: | string |
Description: | Strips ML special control characters from string. |
Usage: | %text = StripMLControlChars(%string); |
StripTrailingSpaces(string) | ||
---|---|---|
Parameters: | string | Input string. |
Return: | string | |
Description: | Strips trailing spaces and underscores from string to be used for player name. | |
Usage: | %name = StripTrailingSpaces( strToPlayerName( %name ) ); |
Strlen(str) | ||
---|---|---|
Parameters: | str | String. |
Return: | numeric | |
Description: | Obtains the number of characters in str. | |
Usage: | %len = Strlen(%weaponName); |
Strlwr(str) | ||
---|---|---|
Parameters: | str | String to be processed. |
Return: | string | The processed resultant string. |
Description: | Converts all characters in str to lowercase. | |
Usage: | %var = Strlwr(%value); |
Strpos(str, target[, offset]) | ||
---|---|---|
Parameters: | str | String to be searched. |
target | String to find. | |
offset | Starts search at offset. (optional) | |
Return: | numeric | |
Description: | Finds the first occurrence of the target string in the search string, with optional starting offset. Note: This function is identical to strstr when offset isn't used. | |
Usage: | %pos = Strpos(%weaponName, "gun") ; |
Strreplace(str, target, subst) | ||
---|---|---|
Parameters: | str | String to be processed. |
target | Target string to be replaced. | |
subst | Substitute string. | |
Return: | string | The processed resultant string. |
Description: | Replaces all instances of target and replaces with subst. | |
Usage: | %dospath = Strreplace(%path, "/", "\"); |
Strstr(str, target) | ||
---|---|---|
Parameters: | str | String to be tested. |
target | Target substring to find. | |
Return: | numeric | Offset within str where target was found. |
Description: | Finds first occurrence of a target within string. | |
Usage: | %loc = Strstr( %weaponName, "stick" ); |
StrToPlayerName(string); | ||
---|---|---|
Parameters: | string | Player name string. |
Return: | string | |
Description: | Converts name string to properly formatted player name string. Proper formatting means the player name is limited to 16 characters in length. Leading and trailing spaces are trimmed; reserved characters are removed. | |
Usage: | %newname = StrToPlayerName( %name ); |
Strupr(str) | ||
---|---|---|
Parameters: | str | String to be processed. |
Return: | string | The processed resultant string. |
Description: | Converts all characters in str to uppercase. | |
Usage: | %var = Strupr(%value); |
SwitchBitDepth() | ||
---|---|---|
Parameters: | none | |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Switches between 16 and 32 bits per pixel in full-screen mode. | |
Usage: | %result = SwitchBitDepth(); |
TelnetSetParameters( port, consolePW, listenPW ) | ||
---|---|---|
Parameters: | port | Connection port. |
consolePW | Console password. | |
listenPW | "Listener" password. | |
Return: | nothing | |
Description: | Initializes telnet connection request parameters. | |
Usage: | TelnetSetParameters(4123, "garage", "games"); |
ToggleFullScreen() | ||
---|---|---|
Parameters: | none | |
Return: | numeric | 1 = success, 0 = fail. |
Description: | Switches between windowed mode and full-screen mode. | |
Usage: | %result = ToggleFullScreen(); |
ToggleInputState() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Toggles DirectInput state between enabled and disabled. Also prints the new input state (same as echoInputState) to the console. |
Usage: | ToggleInputState(); |
ToggleNPatch() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Toggles the enable/disable state of Npatch. |
Usage: | ToggleNPatch(); |
Trace(switch) | ||
---|---|---|
Parameters: | switch | 1 (or true) enables, 0 (or false) disables. |
Return: | nothing | |
Description: | Turns execution trace on or off. | |
Usage: | Trace(true); |
Trim(str) | ||
---|---|---|
Parameters: | str | String to be processed. |
Return: | string | The processed resultant string. |
Description: | Strips any white space from str from the left or right sides (before and after all other characters) of str. White space is defined as space, carriage returns, or new line characters. | |
Usage: | %tidystring = Trim(%yuckystring); |
ValidateMemory() | |
---|---|
Parameters: | none |
Return: | nothing |
Description: | Ensures sufficient memory available for the program. |
Usage: | ValidateMemory(); |
VectorAdd(vector1, vector2) | ||
---|---|---|
Parameters: | vector1 | "x y z". |
vector2 | "x y z". | |
Return: | string | |
Description: | Adds vector2 to vector1. | |
Usage: | %result = VectorAdd("87.21 54.11 10.0", "9.99 12.6 6.00"); |
VectorCross(vector1, vector2) | ||
---|---|---|
Parameters: | vector1 | "x y z". |
vector2 | "x y z". | |
Return: | string | |
Description: | Computes the cross product between two vectors. | |
Usage: | %product = VectorCross("x y z","x y z"); |
VectorDist(vector1, vector2) | ||
---|---|---|
Parameters: | vector1 | "x y z". |
vector2 | "x y z". | |
Return: | string | |
Description: | Computes the distance between two vectors. | |
Usage: | %delta = VectorDist(%vector1, %vector2); |
VectorDot(vector1, vector2) | ||
---|---|---|
Parameters: | vector1 | "x y z". |
vector2 | "x y z". | |
Return: | string | |
Description: | Computes the dot product between two vectors. | |
Usage: | %product = VectorDot("0 0 1",%eye); |
VectorLen(vector) | ||
---|---|---|
Parameters: | vector | "x y z". |
Return: | string | |
Description: | Computes the length of the vector. | |
Usage: | %len = VectorLen(vector); |
VectorNormalize(vector) | ||
---|---|---|
Parameters: | vector | "x y z". |
Return: | string | |
Description: | Normalizes a vector. | |
Usage: | %nvector = VectorNormalize("5 10 30"); |
VectorOrthoBasis(vector) | ||
---|---|---|
Parameters: | vector | "x y z". |
Return: | string | |
Description: | Computes the orthogonal normal for a vector. | |
Usage: | %normal = VectorOrthoBasis("x y z angle"); |
VectorScale(vector, scalar) | ||
---|---|---|
Parameters: | vector | "x y z". |
scalar | Can be an integer or a floating point. | |
Return: | string | |
Description: | Computes the result of the vector sized by the scale. | |
Usage: | %svector = VectorScale("5 10 30", 100); |
VectorSub(vector1, vector2) | ||
---|---|---|
Parameters: | vector1 | "x y z". |
vector2 | "x y z". | |
Return: | string | |
Description: | Subtracts vector2 from vector1. | |
Usage: | %result = VectorSub("34.0989 989.3249 100.00", %position); |
VideoSetGammaCorrection(gamma) | ||
---|---|---|
Parameters: | gamma | Gamma correction setting. |
Return: | nothing | |
Description: | Sets the gamma correction. | |
Usage: | VideoSetGammaCorrection(0.5); |
Warn(text) | ||
---|---|---|
Parameters: | text | String. |
Return: | nothing | |
Description: | Prints text to the console with light gray font. Text can be formatted according to the string rules. | |
Usage: | Warn("Danger, Will Robinson!!"); |