default
core
core
core.TKS
classToHashTable(Object c, HashTable ht) : boolean
- Write the members of the given meta class instance to the given hash table.
constantToString(int c, String prefix) : String
- Try to map a constant integer value to a literal.
evalMethodByName(Object o, String name, Object arglist, Value returnValue) : boolean
- Evaluate the given C++ or meta class method.
findClassesByPrefix(String nspaceName, prefix) : PointerArray
- Find all script and/or C++ classes that match the given class name prefix.
findScriptClass(String nspaceName, className) : Class
- Find the template object for the given script class.
forceUnlockNamedMutex(name )
- Unlock mutex. Should only be called in case something horribly wrent wrong (e.g. a thread holding the mutex has crashed)
getClassID(Object o) : int
- Return the classID of the given C++ object.
getClassName(Object o) : String
- Return the name of the given object
getDllPrefix() : String
- Query prefix for native code DLLs / shared objects.
getDllSuffix() : String
- Query suffix for native code DLLs / shared objects.
getHomeDir() : String
- Query absolute pathname of user home directory.
getMethodArgumentNames(String namespaceName, scriptClassName, methodName) : StringArray
- Query the parameter names of the given script class method.
getMethodNames(Object o) : StringArray
- Query the method names of the given C++ or script class.
getNamespaceName(Object o) : String
- Return the namespace name of the given object
getNumProperties(Object o) : int
- Return the number of meta class members.
getPropertyAccessKeyByIndex(Object o, int index) : int
- Query the access key for the nth member of a meta class object.
getPropertyAccessKeyByName(Object o, String name) : int
- Query the access key for a member of a meta class object.
getPropertyByAccessKey(int ak) : var
- Read meta class member.
getPropertyByName(String name) : var
- Return meta class member value by name.
getPropertyClassName(Object o) : String
- Return the name of a meta class object.
getPropertyNameByAccessKey(int ak) : String
- Return meta class member name.
getTksApplicationPath() : String
- Query absolute pathname of tks application directory.
getTksExeDir() : String
- Query absolute pathname of tks executable.
getTksLibraryPath() : String
- Query absolute pathname of tks library directory.
getTksModulePath() : String
- Query absolute pathname of tks modules directory.
getTksPluginPath() : String
- Query absolute pathname of tks plugins directory.
getVersion() : int
- Return TkScript version identifier.
getVersionString() : String
- Return TkScript version string.
hashTableToClass(HashTable ht, Object c) : boolean
- Iterate hash table and copy the elements to members of "c".
is64Bit() : boolean
- Query whether it's a 64bit runtime environment.
isBigEndian()
- Check whether TKS is running on a big endian host.
lockNamedMutex(name )
- Lock mutex that was declared using the =mutexname= syntax.
newObjectArrayByName(String nspace, name) : Object
- Resolve object name and create an empty array of equally typed objects.
newObjectByID(int classID) : Object
- Return a new instance of the given C++ class.
newObjectByName(String nspace, name) : Object
- Create a new instance of a script or C++ class.
reinstallDebugHandler()
- Hack to re-install exception filter after a DLL has changed it.
scriptClassConstantToString(Value vo, Class clazz, String prefix) : String
- Try to map a constant to script class constant name.
setFloatPropertyByName(Object o, String name, float f)
- Set a float member of a meta class object.
setIntPropertyByName(Object o, String name, int i)
- Set an integer member of a meta class object.
setObjectPropertyByName(Object o, String name, Object o)
- Set an object member of a meta class object.
sleep(int milliSec)
- Suspend the current thread for the given number of milli seconds.
stringToConstant(String name) : var
- Try to map a named constant to its value.
unlockNamedMutex(name )
- Unlock mutex that was declared using the =mutexname= syntax.
yield()
- Yield CPU time to the next thread.int
SIGABRT
-
int
SIGFPE
-
int
SIGILL
-
int
SIGINT
-
int
SIGSEGV
-
int
SIGTERM
-
int
YAC_BIG_ENDIAN
- Stream byteorder (MSB first)
int
YAC_LITTLE_ENDIAN
- Stream byteorder (LSB first)
int
YAC_OP_ADD
- Object.yacOperator()
command id (add)
int
YAC_OP_AND
- Object.yacOperator()
command id (bitwise and)
int
YAC_OP_ASSIGN
- Object.yacOperator()
command id (assign)
int
YAC_OP_BITNOT
- Object.yacOperator()
command id (bitwise not)
int
YAC_OP_CEQ
- Object.yacOperator()
command id (compare equal)
int
YAC_OP_CGE
- Object.yacOperator()
command id (compare greater equal)
int
YAC_OP_CGT
- Object.yacOperator()
command id (compare greater than)
int
YAC_OP_CLE
- Object.yacOperator()
command id (compare less equal)
int
YAC_OP_CLT
- Object.yacOperator()
command id (compare less than)
int
YAC_OP_CNE
- Object.yacOperator()
command id (compare not equal)
int
YAC_OP_DIV
- Object.yacOperator()
command id (divide)
int
YAC_OP_EOR
- Object.yacOperator()
command id (bitwise exclusive or)
int
YAC_OP_INIT
- Object.yacOperator()
command id (init)
int
YAC_OP_LAND
- Object.yacOperator()
command id (logical and)
int
YAC_OP_LEOR
- Object.yacOperator()
command id (logical exclusive or)
int
YAC_OP_LOR
- Object.yacOperator()
command id (logical or)
int
YAC_OP_MOD
- Object.yacOperator()
command id (modulo)
int
YAC_OP_MUL
- Object.yacOperator()
command id (multiply)
int
YAC_OP_NEG
- Object.yacOperator()
command id (negate)
int
YAC_OP_NOT
- Object.yacOperator()
command id (logical not)
int
YAC_OP_OR
- Object.yacOperator()
command id (bitwise or)
int
YAC_OP_SHL
- Object.yacOperator()
command id (shift left)
int
YAC_OP_SHR
- Object.yacOperator()
command id (shift right)
int
YAC_OP_SUB
- Object.yacOperator()
command id (subtract)
int
YAC_TYPE_FLOAT
-
int
YAC_TYPE_INT
-
int
YAC_TYPE_OBJECT
-
int
YAC_TYPE_STRING
-
int
YAC_TYPE_VOID
-
Method classToHashTable | |||
Write the members of the given meta class instance to the given hash table. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method constantToString | ||||||||
Try to map a constant integer value to a literal. | ||||||||
Signature | ||||||||
Arguments | ||||||||
| ||||||||
Returns | ||||||||
Method evalMethodByName | |||
Evaluate the given C++ or meta class method. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method findClassesByPrefix | ||||||||||||||||||||
Find all script and/or C++ classes that match the given class name prefix. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Description | ||||||||||||||||||||
If nspaceName is "yac", only C++ will be searched. This method supports the => operator. |
Method findScriptClass | |||
Find the template object for the given script class. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method forceUnlockNamedMutex | |||||
Unlock mutex. Should only be called in case something horribly wrent wrong (e.g. a thread holding the mutex has crashed) | |||||
Signature | |||||
| |||||
Arguments | |||||
| |||||
Description | |||||
This method might be removed, pls don't call. |
Method getClassID | ||||||||||
Return the classID of the given C++ object. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method getClassName | ||||
Return the name of the given object | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
|
Method getDllPrefix | |||||
Query prefix for native code DLLs / shared objects. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getDllSuffix | |||||
Query suffix for native code DLLs / shared objects. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getHomeDir | |||||
Query absolute pathname of user home directory. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getMethodArgumentNames | |||||||||||||||||||||||||
Query the parameter names of the given script class method. | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
|
Method getMethodNames | ||||||||||
Query the method names of the given C++ or script class. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method getNamespaceName | ||||
Return the namespace name of the given object | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
|
Method getNumProperties | ||||||||||
Return the number of meta class members. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method getPropertyAccessKeyByIndex | ||||||||||||||||||||
Query the access key for the nth member of a meta class object. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Description | ||||||||||||||||||||
This is a tool method to handle meta class objects like e.g. script classes. |
Method getPropertyAccessKeyByName | |||
Query the access key for a member of a meta class object. | |||
Signature | |||
Arguments | |||
Returns | |||
| |||
Description | |||
This is a tool method to handle meta class objects like e.g. script classes. |
Method getPropertyByAccessKey | ||||||||||
Read meta class member. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method getPropertyByName | ||||||||||
Return meta class member value by name. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method getPropertyClassName | ||||
Return the name of a meta class object. | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
|
Method getPropertyNameByAccessKey | ||||||||||
Return meta class member name. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method getTksApplicationPath | |||||
Query absolute pathname of tks application directory. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getTksExeDir | |||||
Query absolute pathname of tks executable. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getTksLibraryPath | |||||
Query absolute pathname of tks library directory. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getTksModulePath | |||||
Query absolute pathname of tks modules directory. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getTksPluginPath | |||||
Query absolute pathname of tks plugins directory. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getVersion | |||||
Return TkScript version identifier. | |||||
Signature | |||||
| |||||
Returns | |||||
| |||||
Description | |||||
The format is 0xmmiirrpp, where mm=major version, ii=minor version major, rr=release number, pp=patch. |
Method getVersionString | |||||
Return TkScript version string. | |||||
Signature | |||||
| |||||
Returns | |||||
| |||||
Description | |||||
Each byte is converted to decimal, sub-version numbers are separated by the '.' char. |
Method hashTableToClass | |||
Iterate hash table and copy the elements to members of "c". | |||
Signature | |||
Arguments | |||
Returns | |||
| |||
Description | |||
All deletable objects will be unlinked from the hashtable. |
Method is64Bit | |||||
Query whether it's a 64bit runtime environment. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isBigEndian | |||
Check whether TKS is running on a big endian host. | |||
Signature | |||
|
Method lockNamedMutex | |||||
Lock mutex that was declared using the =mutexname= syntax. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method newObjectArrayByName | |||
Resolve object name and create an empty array of equally typed objects. | |||
Signature | |||
Arguments | |||
Returns | |||
| |||
Description | |||
If the object class has a special array object (see Object.yacArrayNew() ), an instance of the given array object class will be returned. A generic ObjectArray will be created, otherwise. |
Method newObjectByID | ||||||||||
Return a new instance of the given C++ class. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
This method has to be used with care since classIDs are not constants and may vary between different releases of TkScript. Plugin classes always have dynamic class IDs. |
Method newObjectByName | |||
Create a new instance of a script or C++ class. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method reinstallDebugHandler | |||
Hack to re-install exception filter after a DLL has changed it. | |||
Signature | |||
|
Method scriptClassConstantToString | |
Try to map a constant to script class constant name. | |
Signature | |
Arguments | |
Returns | |
Method setFloatPropertyByName | |
Set a float member of a meta class object. | |
Signature | |
Arguments | |
Description | |
This is a tool method to handle meta class objects like e.g. script classes. |
Method setIntPropertyByName | |
Set an integer member of a meta class object. | |
Signature | |
Arguments | |
Description | |
This is a tool method to handle meta class objects like e.g. script classes. |
Method setObjectPropertyByName | |
Set an object member of a meta class object. | |
Signature | |
Arguments | |
Description | |
This is a tool method to handle meta class objects like e.g. script classes. |
Method sleep | |||||
Suspend the current thread for the given number of milli seconds. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method stringToConstant | ||||||||||
Try to map a named constant to its value. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method unlockNamedMutex | |||||
Unlock mutex that was declared using the =mutexname= syntax. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method yield | |||
Yield CPU time to the next thread. | |||
Signature | |||
|
Constant SIGABRT (int) | |
Constant SIGFPE (int) | |
Constant SIGILL (int) | |
Constant SIGINT (int) | |
Constant SIGSEGV (int) | |
Constant SIGTERM (int) | |
Constant YAC_BIG_ENDIAN (int) | |
Stream byteorder (MSB first) | |
Constant YAC_LITTLE_ENDIAN (int) | |
Stream byteorder (LSB first) | |
Constant YAC_OP_ADD (int) | |
Object.yacOperator() command id (add) | |
Constant YAC_OP_AND (int) | |
Object.yacOperator() command id (bitwise and) | |
Constant YAC_OP_ASSIGN (int) | |
Object.yacOperator() command id (assign) | |
Constant YAC_OP_BITNOT (int) | |
Object.yacOperator() command id (bitwise not) | |
Constant YAC_OP_CEQ (int) | |
Object.yacOperator() command id (compare equal) | |
Constant YAC_OP_CGE (int) | |
Object.yacOperator() command id (compare greater equal) | |
Constant YAC_OP_CGT (int) | |
Object.yacOperator() command id (compare greater than) | |
Constant YAC_OP_CLE (int) | |
Object.yacOperator() command id (compare less equal) | |
Constant YAC_OP_CLT (int) | |
Object.yacOperator() command id (compare less than) | |
Constant YAC_OP_CNE (int) | |
Object.yacOperator() command id (compare not equal) | |
Constant YAC_OP_DIV (int) | |
Object.yacOperator() command id (divide) | |
Constant YAC_OP_EOR (int) | |
Object.yacOperator() command id (bitwise exclusive or) | |
Constant YAC_OP_INIT (int) | |
Object.yacOperator() command id (init) | |
Constant YAC_OP_LAND (int) | |
Object.yacOperator() command id (logical and) | |
Constant YAC_OP_LEOR (int) | |
Object.yacOperator() command id (logical exclusive or) | |
Constant YAC_OP_LOR (int) | |
Object.yacOperator() command id (logical or) | |
Constant YAC_OP_MOD (int) | |
Object.yacOperator() command id (modulo) | |
Constant YAC_OP_MUL (int) | |
Object.yacOperator() command id (multiply) | |
Constant YAC_OP_NEG (int) | |
Object.yacOperator() command id (negate) | |
Constant YAC_OP_NOT (int) | |
Object.yacOperator() command id (logical not) | |
Constant YAC_OP_OR (int) | |
Object.yacOperator() command id (bitwise or) | |
Constant YAC_OP_SHL (int) | |
Object.yacOperator() command id (shift left) | |
Constant YAC_OP_SHR (int) | |
Object.yacOperator() command id (shift right) | |
Constant YAC_OP_SUB (int) | |
Object.yacOperator() command id (subtract) | |
Constant YAC_TYPE_FLOAT (int) | |
Constant YAC_TYPE_INT (int) | |
Constant YAC_TYPE_OBJECT (int) | |
Constant YAC_TYPE_STRING (int) | |
Constant YAC_TYPE_VOID (int) | |
auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54