Multiplayer Interactive-Fiction Game-Design Blog
Download 8.87 Mb.
|
Constructor2Automatically run immediately after an object is reloaded. If an object supports the Constructor2() method then when the object is reloaded from a saved session (NOT created), the Constructor2() method will automtically be called. If an object has one or more superclasses with Constructor2()'s the superclass's constructors will be called first, working its way up the chain to the object's Constructor2(). NOTE: The object should NOT delete itself in its own Constructor2().
Overrides: Call all the methods, from lowest to highest priority – don’t stop Common to all objects ContainedInGetReturns the object that contains this object. This returns the object that contains the current object. For example: If the "money" object is contained within the "wallet" object it will return the wallet object.
Overrides: Call only the highest priority method ContainedInSetMoves the object into another object. This moves the object so it's contained by another object. For example: money.ContainedInSet (wallet); return money.ContainedInGet(); This resturns "wallet".
Overrides: Call only the highest priority method Common to all objects ContainsEnumReturns a list of objects that this object contains. This returns a list of objects that are contained by this object. For example: money.ContainedInSet (wallet); return wallet.ContainsEnum(); This returns [money].
Overrides: Call only the highest priority method Common to all objects DeleteWithContentsDeletes the object along with all its contained objects. This deletes the object along with all the object it contains, and the ones they contain. If you just with to delete the object by itself (and leave the contained objects around) then call "delete Common to all objects DestructorAutomatically run immediately before the object is destroyed. If an object supports the Destructor() method then when the object is deleted, the Destructor() method will automtically be called. If an object has one or more superclasses with Destructor()'s the object's destructor will be called first, working its way down to the superclasses. When an application is quickly shut down, the destructors of the remaining objects may not be called (to speed up shutdown.) NOTE: The object should NOT delete itself in its own Destructor().
Overrides: Call all the methods, from highest to lowest priority – don’t stop NOT Common to all objects LayerAddAdds a new layer to an object. This adds a new layer to an object. The index of the layer (for purposes of LayerGet(), etc.) will depend upon the priority. Adding a new layer will add all of the methods of the class to the object. It will NOT add the properties of the class, although if the class provides any property get/set code, that will be added. Example:
Object.LayerAdd ("LayerName", "LayerClass", 43.54);
Overrides: Call only the highest priority method Common to all objects LayerGetGets information about a layer. This returns information about a layer: its name, class, and priority. Example: return Object.LayerGet (0); Returns ["LayerName", "LayerClass", 43.54].
Overrides: Call only the highest priority method Common to all objects LayerMethodAddAdds an individual method to a layer. This adds an individual method to a layer. Applications can use this to dynamically create methods for objects. Example: Object.LayerMethodAdd (0, "MyNewMethod", Trace); This adds a new method to layer 0, called "MyNewMethod". When the method is called, it really calls into the code of the function, "Trace".
Overrides: Call only the highest priority method Common to all objects LayerMethodEnumReturns a list of methods in the layer. This returns a list of methods in the layer. If it is enumerating class-defined methods then it only enumerates the public ones. If enumerating invidually added methods then it enumerates all of them. Example:
return Object.LayerMethodEnum(0, TRUE);
Overrides: Call only the highest priority method Common to all objects LayerMethodRemoveRemoves an individual method to a layer. This removes an individual method to a layer. Applications can use this to dynamically remove methods for objects. Example: Object.LayerMethodRemove (0, "MyNewMethod"); The removes "MyNewMethod" which was added by calling LayerMethodAdd().
Overrides: Call only the highest priority method Common to all objects LayerNumberReturns the number of layers in an object. This returns the number of layers in an object.
Overrides: Call only the highest priority method Common to all objects LayerPropGetSetAddAdds code for getting or setting a property to a layer. This adds code for getting or setting an individual property to a layer. Applications can use this to dynamically create code to intercept property get and set for an object. (If no code exists then the property is accessed directly.) Example: Object.PropertySet ("MyNewProp", 0); Object.LayerPropGetSetAdd (0, "MyNewProp", GetFunc, SetFunc); After this is called, any attempts to change "MyNewProp" will be passed to SetFunc(), and any attemps to get the value will be passed to GetFunc().
Overrides: Call only the highest priority method Common to all objects LayerPropGetSetEnumReturns a list of properties supported by the layer. This returns a list of properties supported by the layer. If it is enumerating class-defined properties then it only enumerates the public ones. If enumerating invidually added properties then it enumerates all of them. Example:
return Object.LayerPropGetSetEnum(0, TRUE);
Overrides: Call only the highest priority method Common to all objects LayerPropGetSetRemoveRemoves an individual property from a layer. This removes an individual property from a layer. Applications can use this to dynamically remove property get/set code for objects. Example: Object.LayerPropGetSetRemove (0, "MyNewProp"); The removes "MyNewProp" which was added by calling LayerPropGetSetAdd().
Overrides: Call only the highest priority method Common to all objects LayerRemoveRemoves a layer from an object. This removes a layer from an object. Removing the layer will also remove methods provided for in that layer.
Overrides: Call only the highest priority method Common to all objects ListAppendAppends a list to the end of another. This appends a list's elements to the end of the current list. Replacement is IN PLACE, causing the original list to be modified. Example: list = [1,2,3,[5,6]]; string.ListAppend ([8,9]); The resulting list is [1,2,3,[5,6],8,9]
Overrides: Call only the highest priority method Common to all objects ListConcatAppends one or items to the end of the string list. This concatenates one or more items onto the end of the current list. Any lists added are created as sub-lists. The current list is modified in place. Example: var list = [1,2,3]; list.ListConcat (4, [5,6]); results in: list = [1,2,3,4,[5,6]]
Overrides: Call only the highest priority method Common to all objects ListInsertInserts a list before the element of another. This inserts a list's elements before an element in the current list. Replacement is IN PLACE, causing the original list to be modified. Example: list = [1,2,3,[5,6]]; string.ListInsert ([8,9], 1); The resulting list is [1,8,9,2,3,[5,6]] If AddSubLists is TRUE then the result would be: [1,[8,9],2,3,[5,6]]
Overrides: Call only the highest priority method NOT Common to all objects ListMergeMerges the second list onto the first. This merges a second list onto the end of the first. The current list is modified in place. Example: var list = [1,2,3]; list.ListConcat ([5,6]); results in: list = [1,2,3,5,6]
Overrides: Call only the highest priority method NOT Common to all objects ListNumberReturns the number of items in the list. This returns the number of items in the list. Example: var list = [1,2,3,[5,6]]; return list.ListNumber(); Returns 4.
Overrides: Call only the highest priority method NOT Common to all objects ListPrependPrepends a list to the beginning of another. This prepends a list's elements to the start of the current list. Replacement is IN PLACE, causing the original list to be modified. Example: list = [1,2,3,[5,6]]; string.ListPrepend ([8,9]); The resulting list is [8,9,1,2,3,[5,6]]
Overrides: Call only the highest priority method NOT Common to all objects ListRandomizeRandomizes the orders of the elements in the list. This randomizes the order of the elements in the list. The list is modified in place. NOTE: This uses the Random() function for generating the random numbers. If your code has been relying on a random seed this will change the seed. Example:
var list = [1,2,3,[5,6]]; list.ListRandomize();
Overrides: Call only the highest priority method NOT Common to all objects ListRemoveRemoves one or more items from the list. This removes one or more items from the list. The current list is modified in place. Example: var list = ["a", "hello", "c", "e"]; list.ListRemove (1, 3); results in: list = ["a", "e"];
Overrides: Call only the highest priority method NOT Common to all objects ListReplaceReplaces a portion of one list with another. This replaces a portion of the current list with another. Replacement is IN PLACE, causing the original list to be modified. Example: list = [1,2,3,[5,6]]; string.ListReplace ([8,9], 1, 2); The resulting list is [1,8,9,3,[5,6]]
Overrides: Call only the highest priority method NOT Common to all objects ListReverseReverses the elements in the list. This reverses the elements in the list. The list is modified in place. Example: var list = [1,2,3,[5,6]]; list.ListReverse(); Results:
list = [[5,6],3,2,1]
Overrides: Call only the highest priority method NOT Common to all objects ListSearchSearches through a sorted list for an element. This searches through a sorted list for an element. It returns the index to the element, or -1 if it can't be found. The list have been sorted using ListSort() with the same SortingFunction that's passed in. Example:
list = ["a", "e", g", "z"]; return string.ListSearch ("e"); This returns 1.
Overrides: Call only the highest priority method NOT Common to all objects ListSearchToInsertSearches through a sorted list for an element to insert before. This searches through a sorted list for an element to insert before. It can be used to keep the sorted even when inserting new items. Example: list = ["a", "e", "g", "z"]; list.ListInsert ("h", list.ListSearchToInsert("h")); The new list will be ["a", "e", "g", "h", "z"];
Overrides: Call only the highest priority method NOT Common to all objects ListSliceCopies a portion of the list into a new list. This copies a portion of the list into a new list. Example: list = [1,2,3,[5,6]]; return list.ListSlice (1, -1); Returns [2,3].
Overrides: Call only the highest priority method NOT Common to all objects ListSortSorts the list. This sorts the list. Sorting is in place, so the current list is changed. Example: list = [6,2,3,1,4]; string.ListSort(); The resulting list is [1,2,3,4,6]
Overrides: Call only the highest priority method NOT Common to all objects ListSubListCopies a portion of the list into a new list. This copies a portion of the list into a new list. Example: list = [1,2,3,[5,6]]; return list.ListSubList(1,3); Returns [2,3].
Overrides: Call only the highest priority method NOT Common to all objects MethodCallCalls a method in an object. This calls a method in an object. It can be used to call methods using a string instead of the method. NOTE: This only calls public methods. For example: return AnObject.MethodCall ("AMethod", 3, 5);
Overrides: Call only the highest priority method Common to all objects MethodEnumReturns a list of the methods supported by the object. This returns a list of methods supported by the object. NOTE: This only returns public methods. For example: return AnObject.MethodEnum (); Returns [Method1, Method2, etc.]
Overrides: Call only the highest priority method Common to all objects MethodQueryReturns TRUE if the object supports the method. This checks to see if an object supports a method and returns TRUE if it exists. NOTE: This only checks public methods. For example: return AnObject.MethodQuery ("AMethod");
Overrides: Call only the highest priority method Common to all objects NameReturns the name of an object. This returns the name of an object. It can called by any function or method. It is automatically called when an object is concatenated to a string so that a proper name can be concatenated. If unsupported, the class that the object was originally created from will be used as the name.
Overrides: Call only the highest priority method Common to all objects PropertyEnumReturns a list of the properties supported by the object. This returns a list of the properties supported by the object. NOTE: This only returns public properties. For example: return AnObject.PropertyEnum (); Returns ["AProperty", "Property2", etc.]
Overrides: Call only the highest priority method Common to all objects PropertyGetGets an object's property using a string for the property name. The gets and object's property, using a string for a property name. NOTE: This only gets public properties. For example: AnObject.AProperty = 5; return AnObject.PropertyGet ("AProperty"); Returns 5.
Overrides: Call only the highest priority method Common to all objects PropertyQueryReturns TRUE if the object supports the property. This checks to see if an object supports a property and returns TRUE if it exists. NOTE: This only checks public properties. For example: AnObject.AProperty = 5; AnObject.PropertyRemove ("AProperty"); return AnObject.PropertyQuery ("AProperty"); Returns FALSE.
Overrides: Call only the highest priority method Common to all objects PropertyRemoveRemoves an object's property. The deletes the object's property, using a string for a property name. NOTE: This only removes public properties. For example: AnObject.AProperty = 5; AnObject.PropertyRemove ("AProperty"); Results: AProperty is removed from the object.
Overrides: Call only the highest priority method Common to all objects PropertySetSets an object's property using a string for the property name. The sets and object's property, using a string for a property name. If the property doesn't already exist in the object it's created. NOTE: This only sets public properties. For example: AnObject.PropertySet ("AProperty", 5); return AnObject.AProperty; Returns 5.
Overrides: Call only the highest priority method Common to all objects StringAppendAppends a string to the current one. This appends the Insert string at the end of the current string. Insertion is IN PLACE, causing the original string to be modified. Example: string = "Hello"; string.StringAppend (" ! "); The resulting string is "Hello ! ".
Overrides: Call only the highest priority method NOT Common to all objects StringCompareCompares two strings. This compares the string with the Compare string. It returns 0 if the two strings are the same, a negative value if the string (this) should be placed before Compare, and a positive value if it should be placed after Comapre. Example: string = "abacus"; return string.StringCompare ("zebra"); Returns a negative number.
Overrides: Call only the highest priority method NOT Common to all objects StringConcatAppends one or more strings to the end of the string object. This concatenates one or strings onto the end of the current string. The current string is modified in place. Example: var string = "Hello"; string.StringConcat (" there ", 534, "."); results in: string == "Hello there 543."
Overrides: Call only the highest priority method NOT Common to all objects StringFormatReplaces %1, %2, etc. in the string. This searches through the string for "%1", "%2", ... "%9" and replaces them with the 1st, 2nd, ... 9th parameter in the StringFormat() call. StringFormat() is extremely useful for fill-in-the-blank strings. Example:
var string = "My %2 is %1."; return string.StringFomat ("Mike", "name"); return "My name is Mike."
Overrides: Call only the highest priority method NOT Common to all objects StringFromCharCreates a string from one or more characters or character codes. This creates a string from one or more characters ('a', 'b', etc.) or character codes (numbers). Example: var string; string = string.StringFromCar (163, '2', '0', '0', '4'); results in, the Pound-sterling symbol followed by "2004"
Overrides: Call only the highest priority method NOT Common to all objects StringInsertInserts one string into another. This inserts the Insert string into the current string. Insertion is IN PLACE, causing the original string to be modified. Example: string = "Hello"; string.StringInsert (" ! ", 1); The resulting string is "H ! ello".
Overrides: Call only the highest priority method NOT Common to all objects StringLengthReturns the number of characters in the string. This returns the number of characters in the string. Example: string = "Hi there!"; return string.StringLength(); Returns 9.
Overrides: Call only the highest priority method NOT Common to all objects StringPrependInserts a string at the beginning. This inserts the Insert string at the beginning of the current string. Insertion is IN PLACE, causing the original string to be modified. Example: string = "Hello"; string.StringPrepend (" ! "); The resulting string is " ! Hello".
Overrides: Call only the highest priority method NOT Common to all objects StringReplaceReplaces a portion of one string with another. This replaces a portion of the current string with another. Replacement is IN PLACE, causing the original string to be modified. Example: string = "Hello"; string.StringReplace (" ! ", 1, 2); The resulting string is "H ! llo".
Overrides: Call only the highest priority method NOT Common to all objects StringSearchFinds an occurence of one string inside another. This searches for the substring within the original string. If it's found then it returns the index into the original string where the substring begins, or -1 if it can't be found. Example: string = "Hi there!"; return string.StringSearch ("there"); Returns 3.
Overrides: Call only the highest priority method NOT Common to all objects StringSliceCopies a portion of the string into a new string. This copies a portion of the stirng into a new string. Example: string = "Hi there!"; return stirng.StringSlice (3,-1); Returns "there".
Overrides: Call only the highest priority method NOT Common to all objects StringSplitSplits the string into multiple strings based on the delimiter. This splits the string into multiple strings based on the delimiter (such as ',' or ' '). The new strings are added to a list, which is returned. Example: string = "1,2,3,,,5,6,7"; return string.StringSplit (','); Returns ["1", "2", "3", "", "", "5", "6", "7"].
Overrides: Call only the highest priority method NOT Common to all objects StringSubStringCopies a portion of the string into a new string. This copies a portion of the stirng into a new string. Example: string = "Hi there!"; return stirng.StringSubString (3,8); Returns "there".
Overrides: Call only the highest priority method NOT Common to all objects StringToLowerConverts the string to lower case. Converts the string to lower case. Example: string = "Hello Mike!"; return string.StringToLower(); Returns"hello mike!".
Overrides: Call only the highest priority method NOT Common to all objects StringToUpperConverts the string to upper case. Converts the string to upper case. Example: string = "Hello Mike!"; return string.StringToUpper(); Returns"HELLO MIKE!".
Overrides: Call only the highest priority method NOT Common to all objects StringTrimTrims whitespace from the beginning and end of the string. This trims the whitespace from the beginning and end of the string. Example: string = " Hello Mike! "; string.Trim(); String's new value is "Hello Mike!"
Overrides: Call only the highest priority method NOT Common to all objects TimerAddAdds a new timer to the object. This adds a new timer to the object. If the timers in the object are suspended then this timer will be added in a suspended state too. Example: Object.TimerAdd ("MyTimer", TRUE, 1.5, MyMethod, Param1, Param2);
Overrides: Call only the highest priority method Common to all objects TimerEnumEnumerates all the timers in an object. This enumerates all the timers in an object. It returns a list with the timers names. Example: Object.TimerAdd ("MyTimer", TRUE, 1.5, MyMethod, Param1, Param2); return Object.TimerEnum(); Returns ["MyTimer"].
Overrides: Call only the highest priority method Common to all objects TimerQueryDeletes a timer from an object. This deletes a timer from an object. Example: Object.TimerAdd ("MyTimer", TRUE, 1.5, MyMethod, Param1, Param2); Object.TimerRemove ("MyTimer");
Overrides: Call only the highest priority method Common to all objects TimerRemoveDeletes a timer from an object. This deletes a timer from an object. Example: Object.TimerAdd ("MyTimer", TRUE, 1.5, MyMethod, Param1, Param2); Object.TimerRemove ("MyTimer");
Overrides: Call only the highest priority method Common to all objects TimerSuspendGetReturns 0.0 if the object's timers are suspended, 1.0 if they're active, or different values if they're slowed down. Returns 0.0 if the object's timers are suspended. Returns 1.0 if the object's timers are active. The object's timers might also be slowed down (a value between 0.0 and 1.0) or sped up (above 1.0). See also TimerSuspendedSet().
Overrides: Call only the highest priority method Common to all objects TimerSuspendSetSuspends, resumes, or changes the speed of an object's timers. This suspends, resumes, or changes the speed of an object's timers. An application can use this to quickly and easily suspend timers for an object when the object is inactive. Or, the object's timers can be slowed down when it doesn't need accurate timing.
Overrides: Call only the highest priority method Common to all objects Download 8.87 Mb. Share with your friends:
|