Name: | Script |
Version: | 1.0 |
ID: | ID_SCRIPT |
Status: | Stable |
Category: | Data |
Date: | December 2003 |
Author: | Rocklyte Systems |
Copyright: | Rocklyte Systems (c) 2000-2003. All rights reserved. |
Short: | The Script class manages the processing of object script files. |
The Script class is provided for the purpose of processing object scripts. This class specifically supports the Dynamic Markup Language (DML), but other script types can be supported through sub-classes. DML is the most common language used throughout the Athene system and the files can be identified by a ".dml" file extension. For a complete introduction on the DML scripting standard, you will need to refer to the DML Whitepaper for all necessary details.
To run an object script, you need to set the Location field and then Activate the Script object. If a particular object script supports arguments, you can set values for them via the SetUnlistedField action. Activating an object script will often cause a large amount of objects to be generated. If you need to find any of these objects, read the ObjectList field to retrieve a list of all objects that were created by the activation process.
The Script class supports the following actions:
Activate Processes a Script. ClosingTag If a Script object is non-static, calling this action will cause it to self-destruct. GetUnlistedField Script arguments can be retrieved through this action. OpeningTag Activates a Script. SetUnlistedField Script arguments can be set through this action.
The Script object consists of the following public fields:
Cache Enables caching for static scripts. Flags Optional flags. Location The location of the file that is to be processed as a script. ObjectList Lists all objects that have been created during the activation of a Script. PrimaryObject Identifies the primary object of a Script. Procedure Allows you to specify a procedure to be executed from within a script. Repeat This field can be used to activate a Script multiple times. RepeatStart Determines the index at which to start a Script's repetition process. Static Set to TRUE to make a Script object static. String May be set to a string to translate if the script data is not in a file. Target Defines the container that the Script objects will be initialised to. TotalArgs Reflects the total number of arguments used on a Script object. TotalObjects Reflects the total number of objects created during a Script's activation process.
Field: | Flags | |||||
Short: | Optional flags. | |||||
Type: | LONG | |||||
Prefix: | SCF | |||||
Status: | Read/Write | |||||
|
Field: | Location | |
Synonyms: | Src | |
Short: | The location of the file that is to be processed as a script. | |
Type: | STRING | |
Status: | Read/Write | |
|
Field: | ObjectList | |
Short: | Lists all objects that have been created during the activation of a Script. | |
Type: | OBJECTID * | |
Status: | Read | |
|
Field: | PrimaryObject | |
Short: | Identifies the primary object of a Script. | |
Type: | OBJECTID | |
Status: | Read | |
|
Field: | Procedure | |
Short: | Allows you to specify a procedure to be executed from within a script. | |
Type: | STRING | |
Status: | Get/Set | |
|
Field: | Repeat | |
Short: | This field can be used to activate a Script multiple times. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | RepeatStart | |
Short: | Determines the index at which to start a Script's repetition process. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | Static | |
Short: | Set to TRUE to make a Script object static. | |
Type: | LONG | |
Status: | Read/Init | |
|
Field: | String |
Short: | May be set to a string to translate if the script data is not in a file. |
Type: | STRING |
Status: | Get/Set |
Field: | Target | |
Short: | Defines the container that the Script objects will be initialised to. | |
Type: | OBJECTID | |
Status: | Read/Init | |
|
Field: | TotalArgs | |
Short: | Reflects the total number of arguments used on a Script object. | |
Type: | LONG | |
Status: | Read | |
|
Field: | TotalObjects | |
Short: | Reflects the total number of objects created during a Script's activation process. | |
Type: | LONG | |
Status: | Read | |
|