Property Definitions No property definitions in the library. Objects

Property Definitions

Objects

Functions

Abs

Returns the absolute value of a number.

ACos

Returns the arc-cosine of a number.

ASin

Returns the arc-sine of a number.

ATan

Returns the arc-tangent of a number.

ATan2

Returns the arc-tangent of a number.

Ceil

If this isn't an integer, return's the next highest integer.

Example:

ceil (123) returns 123.

ceil (123.1) returns 124.

ceil (123.8) returns 124.

ceil (-1.1) returns -1.

Parameter Name	Description
Value	A number.
Return value description	Next highest integer.

ClassesEnum

This enumerates all the classes as strings. You can pass a class string into ObjectNew(), for example.

Cos

Returns the cosine.

CosH

Returns the hypberboloic cosine.

DeleteGroup

This accepts a list of objects and deletes them all at once, including their contained objects.

Exp

Raise the constant, e, to the specified power.

Floor

If this isn't an integer, return's the lowest highest integer.

Example:

floor (123) returns 123.

floor (123.1) returns 123.

floor (123.8) returns 123.

floor (-1.1) returns -2.

Parameter Name	Description
Value	Number.
Return value description	Next lowest integer.

GlobalEnum

This enumerates all the global variables. It returns a list with their names.

GlobalGet

This gets the value of a global.

x = GlobalGet ("MyGlobal");

is equivalent to

x = MyGlobal;

The only difference is that GlobalGet() lets you access globals created after compile time.

GlobalGetSet

This adds code for getting or setting a global. Applications can use this to dynamically create code to intercept a global get and set. (If no code exists then the global is accessed directly.)

Example:

GlobalSet ("MyNewGlobal", 0);

GlobalGetSet ("MyNewGlobal", GetFunc, SetFunc);

After this is called, any attempts to change "MyNewGlobal" will be passed to SetFunc(), and any attemps to get the value will be passed to GetFunc().

GlobalQuery

This tests to see if a global variable exists.

GlobalRemove

This removes a global variable from the list.

GlobalSet

This sets the value of a global.

GlobalSet ("MyGlobal", 54);

is equivalent to

MyGlobal = 54;

The only difference is that GlobalSet() lets you access globals created after compile time.

GUIDStringToObject

This converts a 32-character GUID string (from ObjectToGUIDString()) to an object reference. The string will be converted even if the object does not exist.

IsBOOL

Returns TRUE if the value is a boolean, FALSE if it is any other type.

IsChar

Returns TRUE if the value is a character, FALSE if it is any other type.

IsCharAlpha

Returns TRUE if the character is alphabetical, such as 'A'..'Z' and 'a'..'z', including non-roman.

IsCharAlphaNum

Returns TRUE if the character is alphabetical or numberical, such as 'A'..'Z' and 'a'..'z', including non-roman, or '0'..'9'.

IsCharDigit

Returns TRUE if the character is a digit, '0' .. '9'.

IsCharLower

Returns TRUE if the character is lower case.

IsCharSpace

Returns TRUE if the character is whitespace, such as space, tab, and newline.

IsCharUpper

Returns TRUE if the character is upper case.

IsFunction

Returns TRUE if the value is a function or an method associated with an object, FALSE if it is any other type.

IsInfinite

Returns TRUE if the number is infinite, FALSE if it's finite.

IsList

Returns TRUE if the value is an list, FALSE if it is any other type.

IsMethod

Returns TRUE if the value is a method, FALSE if it is any other type.

IsNan

Returns TRUE if the value is not-a-number (in the floating point sense), FALSE if it is a number (in the floating point sense).

IsNumber

Returns TRUE if the value is a number, FALSE if it is any other type.

IsObject

Returns TRUE if the value is an object, FALSE if it is any other type.

IsResource

Returns TRUE if the value is a resource, FALSE if it is any other type.

IsString

Returns TRUE if the value is a string or string table entry, FALSE if it is any other type.

LanguageGet

Returns the language currently in use by the virtual machine. The current language affects what resources and string table entries are used; since they're language specific.

LanguageSet

This sets the current language.

Changing the language affects what resources and string table entries are used; since they're language specific.

Parameter Name	Description
Language	New language to use. This is a standard Windows language number.
Return value description	None

Log

Returns the natural log of the number.

Log10

Returns the log (base 10) of the number.

Max

Returns the higher of two values.

Min

Returns the lower of two values.

MMLFromList

This does the inverse of MMLToList(). It takes a list, in the same format as is output by MMLToList(), and returns a string with the MML/XML.

MMLToList

A MML string, like "This is a test" is basically an XML string. Resource are also stored in a matter very similar to XML.

This function parses the string or resource, and returns a list with the MML (like XML) all parsed up.

The list contains three elements, [Name, Attributes, Contents].

Name is a string name of the tag, such as "hello".

Attributes is a list containing the attributes of the tag, or NULL if there are no attributes. Each attribute is a sub-list with [AttribName, AttribValue].

Contents is a list containing the contents of the tag, or NULL if there are no contents. The contents are a sub-list with strings, or more sub-lists, are are embeded MML/XML tags.

For example: "This is a test" would be converted to ["hello", [ ["val", "43"] ] , ["This is a test"] ].

ObjectClone

This clones an object or set of objects. All the object's contents (sub-objects) are also cloned.

The object's properties and timers are copies, with references to cloned objects remapped to their clones. If an object is cloned, but its parent is NOT cloned, then the clone's will NOT be contained by any object.

Once all the objects have been cloned, the Property will be set to PropertyValue, and then all the objects will be called with Constructor2().

ObjectEnum

This returns a list of all the objects.

ObjectNew

This creates a new object from a name or other object. It acts like "new XXX;" except that an arbitrary object class can be created.

ObjectQuery

This tests to see if an object exists. An object may have been delete.

For example:

x = new Object;

ObjectQuery(x); // returns TRUE

delete x;

ObjectQuery(x); // returns FALSE

Parameter Name	Description
Object	Object to test.
Return value description	TRUE if the object exists, FALSE if it doesn't.

ObjectToGUIDString

This converts an object reference to a 32-character GUID string. The string is 32 hexadecimal digits that uniquely identify the object.

Pow

Raise a number to the specified power.

Random

This returns a random value.

If no parameters are passed, it's a random value between 0 and 32767.

If one parameter is passed in, and the parameter is a list, this returns one of the elements of the list.

If one parameter is passed in, and the parameter isn't a list, this returns a random number between 0 (inclusive) and Value1. (exclusive)

If two parameters are passed in, this returns a random number between Value1 (inclusive) and Value2 (exclusive).

RandomSeed

This seeds the random value. You can set the seed to ensure that calls to Random() are follow the same pattern every time.

ResourceEnum

This enumerates a list of resources in the project.

ResourceGet

Gets a resource given a string name.

For example: ResourceGet ("rMyResource") will return the resource, rMyResource. If the resource doesn't exist, it returns NULL.

Parameter Name	Description
ResourceString	String for the resource.
Return value description	Resource as a value.

Round

Rounds the value to the nearest integer.

Example:

round (123) returns 123.

round (123.1) returns 124.

round (123.5) returns 124.

round (123.8) returns 124.

round (-1.1) returns -1.

Sin

Returns the sine.

SinH

Returns the hypberboloic sine.

Sqrt

Returns the square root of a number.

Tan

Returns the tangent.

TanH

Returns the hypberboloic tangent.

TimeFromDateTime

This converts from a year, month, day, etc. to a time (in days) since January 1, 2001.

TimeGet

This returns the time. This is a single number, which is the number of days since January 1, 2001.

To convert it to year, month, day, etc. call TimeToDateTime()

Parameter Name	Description
Return value description	Number of days since January 1, 1601.

TimeSinceStart

Returns the number of seconds that the computer has been running.

This is a good time function to check how many seconds, minutes, or hours of real-time have ellapsed.

Parameter Name	Description
Return value description	Number of seconds since the computer was started.

TimeToDateTime

This converts from a time (in days) to a year, month, day, etc.

It accepts a time from TimeGet() or TimeFromDateTime() and returns a list. The elements of the list contain the year, month, day, etc.

Parameter Name	Description
Time	Time from TimeGet() or TimeFromDateTime()
GMT	If TRUE then the time is calculated as GMT (system) time. If FALSE then time is calculated in the local computer's time.
Return value description	Returns a list. List[0] = year (ex: 2004), List[1] = month (1..12), List[2] = day (1..31), List[3] = hour (0..23), List[4] = minute (0..59), List[5] = second (0..59), List[6] = milliseconds (0.999), List[7] = day of week (1..7).

TimeZone

This returns the offset in time for the current time zone, in days. UTC = local time + TimeZone().

ToBool

Converts the value to a boolean.

ToChar

Converts the value to a character.

ToFunction

Converts the value to a function.

ToMethod

Converts the value to a public method.

ToNumber

Converts the value to a number.

ToObject

Converts an object.method to an object, or a hexadecimal string to an object.

If the value is an Object.Method, this will return the object part. If the string is a 32-digit hexadecimal string, this will return an object ID, which may not be valid. If an object is passed in, the same object will be returned. Otherwise, it returns undefined.

Parameter Name	Description
Value	Value of any type.
Return value description	Object or undefined.

ToString

Converts the value to a string.

ToStringMML

Resources uses a tagged text system called MML (very similar to XML). MML uses special characters, like < and > to indicate the start of a section, such as:

Because some characters are used by the tag system (< and >), these can't be included directly in the strings. These need to be converted to character codes. In this case, '>' is converted to '<' and '<' is converted to '>'.

If you want to create create your own resources that include strings you will need to do these conversions. The easiest way is to use the ToStringMML() function.

For example: To speak "2 <3" you would use:

"" + ToStringMML("2 < 3") + "

This produces the string:

"2 < 3"

Parameter Name	Description
String	The string that is to be "sanitizied" so it can be placed in a resource string.
Return value description	Sanitized version of the string, which characters like '<' converted to '<', etc.

Trace

Calling trace with a string (or other value) will output the string to the debug trace. It will also output the string for logging purposes.

For example:

Trace ("Write this in the log.\n");

will write the data in the log.

Parameter Name	Description
String	String that should be output to the debug trace, or the log.
Return value description	None

TypeOf

Returns the data's type as a string.

The following strings are returned:

"bool" for a boolean

"char" for a character

"function" for a function

"list" for a list

"list.method" for a method call into a list

"method" for a method

"number" for a number

"null" for a NULL value

"object" for an object

"object.method" for a method call into an object

"resource" for a resource reference

"string" for a string

"string.method" for a method call into a string

"stringtable" for a stringtable reference

"undefined" for undefined