core
core
ceil(float f) : float (core)
- Round to next bigger integer
exit(int return) (core)
- Exit with the given return code
floor(float f) : float (core)
- Round to next smaller integer
GetCurrentThread() : Thread (core)
- Query current thread object
getenv(String name) : String (core)
- Get environment variable
lcchar(char c) : char (core)
- Convert character to lower case
mathAbsMaxf(float x, y) : float (core)
- Return absolutely bigger value
mathAbsMinf(float x, y) : float (core)
- Return absolutely smaller value
mathAbsMini(int x, y) : int (core)
- Return absolutely smaller value
mathAbsMini(int x, y) : int (core)
- Return absolutely bigger value
mathClampf(float a, b, t) : float (core)
- Clamp value to min/max range
mathClampi(int a, b, t) : int (core)
- Clamp value to min/max range
mathDistancePointPlane2d(float px, py, qx, qy, nx, ny) : float (core)
- Return distance of point p to infinite plane.
mathLerpf(float a, b, t) : float (core)
- Return linear interpolation of values a and b according to t (0..1) (a*(1-t)+b*t)
mathMaxf(float x, y) : float (core)
- Return bigger value
mathMaxi(int x, y) : int (core)
- Return bigger value
mathMinf(float x, y) : float (core)
- Return smaller value
mathMini(int x, y) : int (core)
- Return smaller value
mathPowerf(float x, y) : float (core)
- Return x raised to the power of y
mathPoweri(int x, y) : int (core)
- Return x raised to the power of y
mathSmoothStepf(float a, b, s) : float (core)
- Return smooth-step interpolation of values a and b according to s (0..1) (a*(1-t)+b*t, with t=(s*s*(3-2*s)) )
mathWrapf(float a, b, t) : float (core)
- Wrap value around min/max range
mathWrapi(int a, b, t) : int (core)
- Wrap value around min/max range
milliSeconds() : int (core)
- Return milliseconds since system start
psystem(String cmd, char access, String buf) : int (core)
- Invoke system command
putenv(String name) : String (core)
- Set environment variable
srand(int seed) (core)
- Set random seed
system(String cmd) (core)
- Invoke system command
ucchar(char c) : char (core)
- Convert character to upper caseBoolean
- A number object that wraps a boolean 1bit integer value.
getString() : String
- Return a string representation of this number object.
getValue() : boolean
- Return the current value.
New(boolean v) : Boolean
- Create a new Boolean object and initialize it with the given value.
News(String s) : Boolean
- Create a new Boolean object and initialize it with the given String.
operator !=(boolean v) : boolean
- Check whether the given value does not equal this value
operator &(boolean v) : Boolean
- Calculate reminder of this divided by the given value
operator &(boolean v) : Boolean
- Bitwise AND
operator &&(boolean v) : boolean
- Logical AND
operator >(boolean v) : boolean
- Check whether this value is greater than the given value
operator >>(boolean v) : Boolean
- Logical shift right
operator >=(boolean v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(boolean v) : boolean
- Check whether this value is less than the given value
operator <<(boolean v) : Boolean
- Logical shift left
operator <=(boolean v) : boolean
- Check whether this value is less than the given value
operator *(boolean v) : Boolean
- Multiply by the given value
operator +(boolean v) : Boolean
- Add the given value
operator -(boolean v) : Boolean
- Subtract the given value
operator /(boolean v) : Boolean
- Divide by the given value
operator ==(boolean v) : boolean
- Compare to the given value
operator unary!() : Boolean
- Logical not
operator unary~() : Boolean
- Bitwise not
operator ^(boolean v) : Boolean
- Bitwise EOR/XOR (exclusive or)
operator ^^(boolean v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(boolean v) : Boolean
- Bitwise OR
operator ||(boolean v) : boolean
- Logical OR
setValue(boolean v)
- Set a new value.Buffer
- An array of bytes.
fillZero()
- Fill the entire buffer with 0.
free()
- Free buffer bytes
getChecksum() : int
- Return checksum for this Buffer.
getString(int off, max) : String
- Extract 0 terminated string from buffer.
gunzip(Buffer src, int off, len, uncompressedSize)
- Uncompress the given source buffer.
gzip(Buffer src, int off, len, level) : boolean
- Compress the given source buffer.
peekF32(int off) : float
- Read 32bit single precision floating point value from the given buffer offset.
peekI16(int off) : short
- Read short integer from the given buffer offset.
peekI32(int off) : int
- Read 32bit integer from the given buffer offset.
peekI8(int off) : byte
- Read byte from the given buffer offset
pokeF32(int off, float value)
- Store 32bit single precision floating point value at the given buffer offset.
pokeI16(int off, short value)
- Store short integer at the given buffer offset.
pokeI32(int off, value)
- Store 32bit integer at the given buffer offset.
pokeI8(int off, byte value)
- Store byte at the given buffer offset
resize(int num) : boolean
- Change the size of the buffer.
setSize(int num) : boolean
- Allocate the given number of bytes.
setString(int off, String s) : boolean
- Store 0 terminated string at the given buffer offset.
substring(String r, int off, max)
- Extract 0 terminated string from buffer. Byte
- A number object that wraps a signed 8bit integer value.
getString() : String
- Return a string representation of this number object.
getValue() : byte
- Return the current value.
New(byte v) : Byte
- Create a new Byte object and initialize it with the given value.
operator !=(int v) : boolean
- Check whether the given value does not equal this value
operator &(int v) : Byte
- Calculate reminder of this divided by the given value
operator &(int v) : Byte
- Bitwise AND
operator &&(int v) : boolean
- Logical AND
operator >(int v) : boolean
- Check whether this value is greater than the given value
operator >>(int v) : Byte
- Logical shift right
operator >=(int v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(int v) : boolean
- Check whether this value is less than the given value
operator <<(int v) : Byte
- Logical shift left
operator <=(int v) : boolean
- Check whether this value is less than the given value
operator *(int v) : Byte
- Multiply by the given value
operator +(int v) : Byte
- Add the given value
operator -(int v) : Byte
- Subtract the given value
operator /(int v) : Byte
- Divide by the given value
operator ==(int v) : boolean
- Compare to the given value
operator unary!() : Byte
- Logical not
operator unary-() : Byte
- Negate value
operator unary~() : Byte
- Bitwise not
operator ^(int v) : Byte
- Bitwise EOR/XOR (exclusive or)
operator ^^(int v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(int v) : Byte
- Bitwise OR
operator ||(int v) : boolean
- Logical OR
printf(String fmt) : String
- Return a string representation of this number object that is formatted using the given ANSI-C format string.
setValue(byte v)
- Set a new value.Class
- A scriptclass (instance).
ClassArray
- Array of scriptclass instances.
add(Class c) : boolean
- Add the given scriptclass instance to this array.
alloc(int max) : boolean
- Allocate the given number of array elements.
contains(Class c) : boolean
- Check whether this array contains a scriptclass instance that equals the given object.
containsObject(Object o) : boolean
- Check whether array contains an object that equals the given object.
containsPointer(Object o) : boolean
- Check whether array contains the given object address.
delete(int index) : boolean
- Delete the given array element.
empty()
- Reset number of used elements, numElements, to 0.
free()
- Free array elements.
get(int index) : Class
- Return the given array element.
getDeref(int index) : Class
- Unlink and return the given (deletable) array element.
getMaxElements() : int
- Return total number of elements.
getNextFree() : Class
- Return next free element.
getNumElements() : int
- Return number of used elements.
getTemplate() : Class
- Return the template object that is currently being used to allocate new array elements.
indexOfObject(Object o) : int
- Return the index of the element that equals the given object.
indexOfPointer(Object o) : int
- Return the index of the element that points to the given object.
insert(int index, Class c) : boolean
- Insert the given scriptclass instance into the array.
realloc(int max) : boolean
- Reallocate array elements.
remove(Class c) : boolean
- Delete the first element whose pointer equals the given scriptclass instance.
reverse()
- Reverse element order.
setNumElements(int num)
- Set number of used elements.
setTemplate(Class sci)
- Set the template object that shall be used to allocate new array elements.
swap(int indexA, indexB) : boolean
- Swap two array elements.
useAll()
- Mark all array elements used, i.e. set numElements = maxElements.Condition
- A boolean condition variable that can be used for multi-threaded notifications resp. barriers.
create(boolean bManualReset) : int
- Initialize condition object.
raise() : int
- Raise condition and notify threads
reset() : int
- Reset condition.
wait(int timeout) : int
- Wait for condition to be raised. Configuration
- Provides access to various TkScript related configuration options.
getDebugLevel() : int
- Return the current TkScript debug level.
getForceInt() : boolean
- Query whether JIT acceleration is enabled.
setDebugLevel(int level)
- Set the TkScript debug level.
setForceInt(boolean b)
- Enable/disable forced interpretation. Double
- A number object that wraps a 64bit IEEE floating point value.
getString() : String
- Return a string representation of this number object.
getValue() : double
- Return the current value.
Newf(float v) : Double
- Create a new Double object and initialize it with the given value.
News(String s) : Double
- Create a new Double object and initialize it with the given String.
operator !=(Double v) : boolean
- Check whether the given value does not equal this value
operator &(int v) : Double
- Calculate reminder of this divided by the given value.
operator &(int v) : Double
- Bitwise AND
operator &&(int v) : boolean
- Logical AND
operator >(Double v) : boolean
- Check whether this value is greater than the given value
operator >>(int v) : Double
- Logical shift right
operator >=(Double v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(Double v) : boolean
- Check whether this value is less than the given value
operator <<(int v) : Double
- Logical shift left
operator <=(Double v) : boolean
- Check whether this value is less than the given value
operator *(Double v) : Double
- Multiply by the given value
operator +(Double v) : Double
- Add the given value
operator -(Double v) : Double
- Subtract the given value
operator /(Double v) : Double
- Divide by the given value
operator ==(Double v) : boolean
- Compare to the given value
operator unary!() : Double
- Logical not
operator unary-() : Double
- Negate value
operator unary~() : Double
- Bitwise not
operator ^(int v) : Double
- Bitwise EOR/XOR (exclusive or)
operator ^^(int v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(int v) : Double
- Bitwise OR
operator ||(int v) : boolean
- Logical OR
printf(String fmt) : String
- Return a string representation of this number object that is formatted using the given ANSI-C format string.
setValue(float v)
- Set a new value.DummyStream
- A no-op Stream
that can be used to determine buffer sizes for real write ops.
setSize(int num) : boolean
- Set stream size.Envelope
- An array of time/value pairs.
get() : float
- Return (interpolated) value and reset new_event flag (SH, SHRESET).
getAndResetNew(boolean ) : float
- Return (interpolated) value. Only reset new event flag if bResetNew is true.
getDeltaTime() : float
- Return delta time to the next event
getInterpolation() : int
- Return current interpolation function.
getNextEventTimeAfter(float t) : float
- Return absolute time of event after _t, or -1 if there is no event.
getSpeed() : float
- Return the current envelope base speed.
getTime() : float
- Return the current time offset.
indexToTime(int event) : float
- Return the absolute time offset of the given event number.
insertReplaceEvent(float t, v, w)
- Insert or replace an event at the given time offset.
insertReplaceEventLSB4(float t, byte v, float w)
- Insert or replace part of an (8bit) event at the given time offset (least significant nibble).
insertReplaceEventMSB4(float t, byte v, float w)
- Insert or replace part of an (8bit) event at the given time offset (most significant nibble).
insertReplaceEventPat1(float t, byte v, float w)
- Insert or replace part of an (7bit) event, formatted as '01A'..'32D' at the given time offset.
insertReplaceEventPat2(float t, byte v, float w)
- Insert or replace part of an (7bit) event, formatted as '01A'..'32D' at the given time offset.
insertReplaceEventPat3(float t, byte v, float w)
- Insert or replace part of an (7bit) event, formatted as '01A'..'32D' at the given time offset.
isNewEvent() : boolean
- Check whether the last tickPrecise()
call hit a new key event.
removeEvent(float t)
- Remove event at the given time offset and shift all succeeding events.
removeRange(float t, len)
- Remove all events within the given time window and shift the succeeding events.
removeRangeSH(float t, len)
- Remove range of sample&hold style envelope.
removeRangeUntilNext(float t, len, maxT)
- Remove range until next event and keep abstime of following event (if any)
reset()
- Reset time offset
rotateEvents(float r, startT, maxT)
- Rotate events within (startT..maxT) by delta time 'r'.
setInterpolation(int interpol)
- Set the interpolation function.
setSpeed(float speed)
- Set envelope base speed.
setTime(float t)
- Seek to the current time offset.
shiftEvents(float t, l)
- Shift all events after the given time offset by the given number of ticks.
shiftNextEvent(float t, l, maxT)
- Shift only next event and keep abstime of following event (if any / in range t..maxT)
tickPrecise(float dt)
- Increase time offset by the given time delta.
timeToIndex(float t) : int
- Return the last event number (not array offset!) before the given time offset.
valueAtTimeRaster(float t, res) : var
- Return the value at the given absolute time offset in the given time window.
valueAtTimeSH(float t) : var
- Return the value of the last event before the given point in time.
ENV_COSINE
- Cosine interpolation
ENV_CUBIC
- Cubic interpolation
ENV_LINEAR
- Linear interpolation.
ENV_QUADRATIC
- Quadratic interpolation.
ENV_QUINTIC
- Quintic interpolation
ENV_SH
- Sample and hold (no interpolation)
ENV_SHRESET
- Sample and hold + reset (no interpolation).
Event
- A generic event.
Exception
- Represents an Error object generated by the throw
statement.
getFullName() : String
- Get exception/error class name, prefixed by parent class name (if any)
getId() : int
- Get exception/error id.
getMessage() : String
- Get the user defined error message.
getName() : String
- Get exception/error class name
getStackTrace() : String
- Return a string-representation of the stack trace (as seen when the error occured).File
- Represents a file in the local file system.
close()
- Close the current file.
flush()
- Write pending buffers to disk..
isOpen() : boolean
- Check whether the File object has a valid file handle.
open(String name, int accessFlags) : boolean
- Open a file in the local file system.
openLocal(String name, int accessFlags) : boolean
- Open a file in the local file system.
seek(int offset, mode)
- Seek to the given file offset.
setOffset(int offset)
- Seek to the given absolute file offset (bytes).int
IOS_IN
- File access mode "read-only".
int
IOS_INOUT
- File access mode "read-write".
int
IOS_OUT
- File access mode "write/create".
int
SEEK_CUR
- Seek relative to current file offset.
int
SEEK_END
- Seek relative to end of file.
int
SEEK_SET
- Seek to absolute file offset.
Float
- A number object that wraps a 32bit IEEE floating point value.
getString() : String
- Return a string representation of this number object.
getValue() : float
- Return the current value.
New(float v) : Float
- Create a new Float object and initialize it with the given value.
operator !=(float v) : boolean
- Check whether the given value does not equal this value
operator &(int v) : Float
- Calculate reminder of this divided by the given value.
operator &(int v) : Float
- Bitwise AND
operator &&(int v) : boolean
- Logical AND
operator >(float v) : boolean
- Check whether this value is greater than the given value
operator >>(int v) : Float
- Logical shift right
operator >=(float v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(float v) : boolean
- Check whether this value is less than the given value
operator <<(int v) : Float
- Logical shift left
operator <=(float v) : boolean
- Check whether this value is less than the given value
operator *(float v) : Float
- Multiply by the given value
operator +(float v) : Float
- Add the given value
operator -(float v) : Float
- Subtract the given value
operator /(float v) : Float
- Divide by the given value
operator ==(float v) : boolean
- Compare to the given value
operator unary!() : Float
- Logical not.
operator unary-() : Float
- Negate value
operator unary~() : Float
- Bitwise not
operator ^(int v) : Float
- Bitwise EOR/XOR (exclusive or)
operator ^^(int v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(int v) : Float
- Bitwise OR
operator ||(int v) : boolean
- Logical OR
printf(String fmt) : String
- Return a string representation of this number object that is formatted using the given ANSI-C format string.
setValue(float v)
- Set a new value.FloatArray
- An arraylist of 32bit floating point values.
add(float f) : boolean
- Add the given float value to this array.
addArray(Object array, int off, len) : boolean
- Add the given array like object to this array.
addEmpty(int num) : int
- Increase the number of used elements.
alloc(int max) : boolean
- Allocate the given number of array elements.
bezierCubicDeCasteljau2d(float x0, y0, x1, y1, x2, y2, x3, y3, scaleX, scaleY, int recMax, float thresholdB, thresholdP, FloatArray retT)
- Calculate bezier curve using the de Casteljau algorithm.
blend(FloatArray b, float weight)
- Blend with other array and write to this array.
blendAB(FloatArray a, b, float weight)
- Blend two arrays and write to this array.
contains(float f) : boolean
- Check whether array contains the given value.
copyFrom(FloatArray src, int off, len, destOff)
- Copy elements from source array.
delete(int index) : boolean
- Delete element at the given index.
empty()
- Reset the number of used elements, numElements, to 0.
fill(float f)
- Set all used elements to the given value.
findNearestIdx1d(float x, int off, stride, float maxDist) : int
- Find index of x-element that has the smallest distance to point x.
findNearestIdx2d(float x, y, int off, stride, float maxDist, aspect) : int
- Treat elements as x/y 2d vectors and find index of x-element that has the smallest distance to point (x,y).
free()
- Free all array elements.
get(int index) : float
- Return element value at the given index.
getAbsMax() : float
- Return biggest element value, not regarding sign.
getAbsMean() : float
- Return average element value, not regarding sign.
getAbsMin() : float
- Return smallest element value, not regarding sign.
getFirst() : float
- Return first array element.
getLast() : float
- Return last used array element.
getMax() : float
- Return biggest element value.
getMaxElements() : int
- Return total number of elements.
getMean() : float
- Return average element value.
getMin() : float
- Return smallest element value.
getNumElements() : int
- Return number of used elements.
getString() : String
- Return string representation of this array.
insert(int index, float f) : boolean
- Insert new element before the given index.
interleave(int numDestCh, destCh, FloatArray src, int numSrcCh, srcCh, numCh, numElem)
- Copy interleaved elements from multi-channel array.
isEqual(FloatArray o) : boolean
- Compare to other array and return true if the array contents are equal.
join(Object a, b)
- Join arrays 'a' and 'b'.
loadFromStreamFloat32(Stream s, int num) : boolean
- Read 24bit IEEE floats from stream.
loadFromStreamSigned16(Stream s, int num) : boolean
- Read signed 16bit integers from stream, convert to float and normalize.
loadFromStreamSigned24(Stream s, int num) : boolean
- Read signed 24bit integers from stream, convert to float and normalize.
loadFromStreamUnsigned8(Stream s, int num) : boolean
- Read unsigned 8bit integers from stream, convert to float and normalize.
read32(Stream ifs, int num, destOff) : int
- Read 32bit floating point values from the given input stream.
read64(Stream ifs, int num, destOff) : int
- Read 64bit floating point values from the given input stream and truncate to 32bit.
realloc(int max) : boolean
- Reallocate array to given size.
rearrange(IntArray order) : boolean
- Rearrange array elements according to the given IntArray.
reverse()
- Reverse element order
scale(FloatArray src, float s)
- Read elements from source array, scale by s and write to this array.
setNumElements(int num)
- Set the number of used elements to the given value.
sortByValue(IntArray order)
- Sort elements by value and write new element order to the given IntArray.
sum(int off, num) : float
- Sum elements
sumPathLen1d(int off, num) : float
- Sum element deltas
sumPathLen2d(int off, num) : float
- Treat elements as x/y 2d vectors and calculate path length.
swap(int indexA, indexB) : boolean
- Swap two array elements.
useAll()
- Mark all array elements used, i.e. set numElements = maxElements.
visit(FloatArray src, int off, len)
- Create a view into the given FloatArray.
winCosine(float index) : float
- Return cosine interpolation of elements.
winCubic(float index) : float
- Return cubic interpolation of elements.
winLinear(float index) : float
- Return linear interpolation of elements.
winQuadratic(float index) : float
- Return quadratic interpolation of elements.
winQuintic(float index) : float
- Return quintic interpolation of elements.
write32(Stream ofs, int num, srcOff) : int
- Write 32bit floating point values to the given output stream.
write64(Stream ofs, int num, srcOff) : int
- Write 64bit floating point values to the given output stream.FloatArray128
- A FloatArray
that can store 128 elements without (re-)allocation.
FloatArray16
- A FloatArray
that can store 16 elements without (re-)allocation.
FloatArray32
- A FloatArray
that can store 32 elements without (re-)allocation.
FloatArray64
- A FloatArray
that can store 64 elements without (re-)allocation.
FloatArray8
- A FloatArray
that can store 8 elements without (re-)allocation.
Function
- Represents a script function.
HashTable
- A dictionary that maps Strings to arbitrary values.
addFloat(String key, float f) : int
-
addInt(String key, int i) : int
-
addObject(String key, Object o) : int
-
addObjectRef(String key, Value v) : int
-
addString(String key, s) : int
-
alloc(int cacheSize) : boolean
-
delete(String key)
-
exists(String key) : boolean
-
free()
-
get(String key) : var
-
getDeref(String key) : var
-
getMaxElements() : int
-
getNumElements() : int
-
getReparsableString() : String
- Prepare keys and string values so they can be reparsed.
getString() : String
-
keyToArray(Object array) : int
-
replaceKey(String oldKey, newKey) : boolean
-
set(String key, Object value)
-
setCopy(String key, Object o)
-
setFloat(String key, float f)
-
setInt(String key, int i)
-
setObject(String key, Object value)
-
setString(String key, s)
-
valuesToArray(Object array) : int
- IntArray
- An arraylist of 32bit integer values.
add(int i)
- Add array element "i".
addArray(Object array, int off, len) : boolean
- Add the given array like object to this array.
addEmpty(int num) : int
- Increase numElements by "num".
alloc(int max) : int
- Allocate the given number of array elements.
contains(int i) : boolean
- Check whether array contains the given integer value.
copyFrom(IntArray src, int off, len, destOff)
- Copy elements from other array.
dec(int idx)
- Decrement element at index 'idx'.
delete(int index) : boolean
- Delete element at index "index".
empty()
- Reset the number of used elements, numElements, to 0.
fill(int i)
- Set all used array elements to value "i".
free()
- Free array elements.
get(index index) : int
- Return element at index "index".
getAbsMax() : int
- Return biggest array element, not regarding sign.
getAbsMean() : float
- Return average element value, not regarding sign.
getAbsMin() : int
- Return smallest array element, not regarding sign.
getFirst() : int
- Return first array element.
getLast() : int
- Return last used array element.
getMax() : int
- Return biggest array element.
getMaxElements() : int
- Return total number of array elements.
getMean() : float
- Return average element value.
getMin() : int
- Return smallest array element.
getNumElements() : int
- Return number of used array elements.
getString() : String
- Return string representation of this array.
identity(int num)
- Reallocate array to "num" elements and set element[i] to i.
inc(int idx)
- Increment element at index 'idx'.
indexOf(int i, off) : int
- Return index of element with value "i". -1 if no matching element was found.
insert(int index, i) : boolean
- Insert new array element "i" before index "index".
join(Object a, b)
- Join arrays 'a' and 'b'.
read16(Stream ifs, int num, destOff) : int
- Read a sequence of 16bit short integers from the given input stream.
read32(Stream ifs, int num, destOff) : int
- Read a sequence of 32bit integers from the given input stream.
read8(Stream ifs, int num, destOff) : int
- Read a sequence of bytes from the given input stream.
realloc(int num) : boolean
- Reallocate array.
rearrange(IntArray order) : boolean
- Reorder elements according to given element order.
replace(int a, b)
- Replace all occurences of 'a' with 'b' and return number of elements replaced.
reverse()
- Reverse element order.
setNumElements(int num)
- Set number of used elements to "num".
sortByValue(IntArray r)
- Sort elements by value and return new element order in "r".
swap(int indexA, indexB) : boolean
- Swap two elements.
swapByteOrder()
- Swap byteorder of all elements.
useAll()
- Mark all array elements used, i.e. set numElements = maxElements.
visit(IntArray src, int off, num)
- Create a view into another IntArray object.
visitBytes(Object src, int off, num) : boolean
- Create a view into another array-like object.
write16(Stream ifs, int num, srcOff) : int
- Write a sequence of 16bit short integers to the given output stream.
write32(Stream ifs, int num, srcOff) : int
- Write a sequence of 32bit integers to the given output stream.
write8(Stream ifs, int num, srcOff) : int
- Write a sequence of 8bit bytes to the given output stream. IntArray128
- An IntArray that can store 128 elements without (re-)allocation.
IntArray16
- An IntArray that can store 16 elements without (re-)allocation.
IntArray32
- An IntArray that can store 32 elements without (re-)allocation.
IntArray64
- An IntArray that can store 64 elements without (re-)allocation.
IntArray8
- An IntArray that can store 8 elements without (re-)allocation.
Integer
- A number object that wraps a signed 32bit integer value.
getString() : String
- Return a string representation of this number object.
getValue() : int
- Return the current value.
New(int v) : Integer
- Create a new Integer object and initialize it with the given value.
operator !=(int v) : boolean
- Check whether the given value does not equal this value
operator &(int v) : Integer
- Calculate reminder of this divided by the given value
operator &(int v) : Integer
- Bitwise AND
operator &&(int v) : boolean
- Logical AND
operator >(int v) : boolean
- Check whether this value is greater than the given value
operator >>(int v) : Integer
- Logical shift right
operator >=(int v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(int v) : boolean
- Check whether this value is less than the given value
operator <<(int v) : Integer
- Logical shift left
operator <=(int v) : boolean
- Check whether this value is less than the given value
operator *(int v) : Integer
- Multiply by the given value
operator +(int v) : Integer
- Add the given value
operator -(int v) : Integer
- Subtract the given value
operator /(int v) : Integer
- Divide by the given value
operator ==(int v) : boolean
- Compare to the given value
operator unary!() : Integer
- Logical not
operator unary-() : Integer
- Negate value
operator unary~() : Integer
- Bitwise not
operator ^(int v) : Integer
- Bitwise EOR/XOR (exclusive or)
operator ^^(int v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(int v) : Integer
- Bitwise OR
operator ||(int v) : boolean
- Logical OR
printf(String fmt) : String
- Return a string representation of this number object that is formatted using the given ANSI-C format string.
setValue(int v)
- Set a new value.List
- A container for list nodes.
addFirst(Object o) : ListNode
-
addFirstCopy(Object o) : ListNode
-
addFirstFloat(float f) : ListNode
-
addFirstInt(int i) : ListNode
-
addFirstObject(Object o) : ListNode
-
addFirstString(String s) : ListNode
-
addLast(Object o) : ListNode
-
addLastCopy(Object o) : ListNode
-
addLastFloat(float f) : ListNode
-
addLastInt(int i) : ListNode
-
addLastObject(Object o) : ListNode
-
addLastString(String s) : ListNode
-
findPointer(Object o) : ListNode
-
getCopy() : var
-
getHead() : ListNode
-
getSize() : int
-
getString() : String
-
getSubList(int off) : ListNode
-
getTail() : ListNode
-
insert(Object o, ln) : ListNode
-
inverse()
-
isEmpty() : boolean
-
remove(Object o) : ListNode
-
removeAll() : ListNode
-
removeFirst() : ListNode
-
removeLast() : ListNode
- ListNode
- Represents a single node in a double linked list. Can store arbitrary script values.
append(Object value) : ListNode
- Append empty list node and copy value.
appendEmpty() : ListNode
-
appendValue(Value v) : ListNode
-
freeList()
-
getCopy() : var
-
getDebugString() : String
-
getDebugStrings() : StringArray
-
getHead() : ListNode
-
getNext() : ListNode
-
getPrev() : ListNode
-
getSize() : int
-
getString() : String
-
getSubList(int off) : ListNode
-
getTail() : ListNode
- Long
- A number object that wraps a signed 32bit integer value.
getString() : String
- Return a string representation of this number object.
getValue() : int
- Return the current value.
Newi(int v) : Long
- Create a new Long object and initialize it with the given value.
News(String s) : Long
- Create a new Long object and initialize it with the given String.
operator !=(Long v) : boolean
- Check whether the given value does not equal this value
operator &(Long v) : Long
- Calculate reminder of this divided by the given value
operator &(Long v) : Long
- Bitwise AND
operator &&(Long v) : boolean
- Logical AND
operator >(Long v) : boolean
- Check whether this value is greater than the given value
operator >>(Long v) : Long
- Logical shift right
operator >=(Long v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(Long v) : boolean
- Check whether this value is less than the given value
operator <<(Long v) : Long
- Logical shift left
operator <=(Long v) : boolean
- Check whether this value is less than the given value
operator *(Long v) : Long
- Multiply by the given value
operator +(Long v) : Long
- Add the given value
operator -(Long v) : Long
- Subtract the given value
operator /(Long v) : Long
- Divide by the given value
operator ==(Long v) : boolean
- Compare to the given value
operator unary!() : Long
- Logical not
operator unary-() : Long
- Negate value
operator unary~() : Long
- Bitwise not
operator ^(Long v) : Long
- Bitwise EOR/XOR (exclusive or)
operator ^^(Long v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(Long v) : Long
- Bitwise OR
operator ||(Long v) : boolean
- Logical OR
printf(String fmt) : String
- Return a string representation of this number object that is formatted using the given ANSI-C format string.
setValue(int v)
- Set a new value.Mailbox
- A generic event mailbox.
allocEventQueue(int size)
- Discard events and allocate new (empty) queue
freeEventQueue()
- Discard all events
getNumQueuedEvents() : int
- thread-safe way to get the number of queued events
peekEvent(int id) : Event
- Return reference to oldest event that matches the given id
peekEvent() : Event
- Return reference to oldest event without removing it from the queue
sendEvent(Event ev)
- Create a copy of "ev" (deref value) and add to queue
waitEvent(int id, timeout) : Event
- Wait until next event arrives that matches the given id or until timeout expires. return null or next event
waitEvent(int timeout) : Event
- Wait until next event arrives or until timeout expires. return null or next eventMutex
- A mutual exclusive lock is used to avoid the simultaneous execution of a specific code path.
Object
- This is the baseclass for all scriptengine objects.
yacArrayAlloc(int sx, sy, type, elementByteSize) : boolean
- Allocate array elements.
yacArrayCopySize(Object o)
- Copy array size from object "o".
yacArrayGet(int index, Value r)
- Get array element
yacArrayGetDeref(int index, Value r)
- Get (deletable) array element.
yacArrayGetElementByteSize() : int
- Return the size of a single array element.
yacArrayGetElementType() : int
- Return the array element type.
yacArrayGetHeight() : int
- Return the array height.
yacArrayGetMaxElements() : int
- Return the total number of array elements.
yacArrayGetNumElements() : int
- Return the number of used array elements.
yacArrayGetStride() : int
- Return the number of bytes between two consecutive lines.
yacArrayGetWidth() : int
- Return the array width.
yacArrayNew() : Object
- Return new array object for this object.
yacArrayRealloc(int sx, sy, type, elementByteSize) : int
- Re-allocate array elements.
yacArraySet(int index, Value v)
- Set array element.
yacArraySetHeight(int sy)
- Set the array height.
yacArraySetTemplate(Object template)
- Set the template object to use for allocation of new array elements.
yacArraySetWidth(int sx)
- Set the array width.
yacCanDeserializeClass(Stream ifs) : boolean
- Check whether this class can be deserialized from the given inputstream.
yacClassName() : String
- Return the class name.
yacConstantGetNames() : StringArray
- Return the names of the C++ constants.
yacConstantGetNum() : int
- Return the number of constants of a C++ class.
yacConstantGetTypes() : IntArray
- Return the types of the C++ constants.
yacConstantGetValues() : ValueArray
- Return the C++ constant values.
yacCopy(Object o) : boolean
- Copy object data from "o".
yacDeserialize(Stream ifs, boolean bTypeInfo)
- Deserialize object from the given inputstream.
yacEquals(Object o) : boolean
- Compare this to object "o".
yacGetSignalStringList() : String
- Return a String that describe the signal names and callback signatures
yacHashGet(String key, Value r)
- Get a hashtable entry.
yacHashGetDeref(String key, Value r)
- Get (deletable) hashtable element.
yacHashSet(String key, Value value)
- Modify/create a hashtable entry.
yacInstanceOf(Object o) : boolean
- Check whether this C++ class is an instance of C++ class "o".
yacIsStream() : boolean
- Check whether object is a Stream
.
yacMemberGetNames() : StringArray
- Return the C++ member names.
yacMemberGetNum() : int
- Return the number of C++ members.
yacMemberGetObjectTypes() : StringArray
- Return the class names of the C++ object members.
yacMemberGetOffsets() : IntArray
- Return the byteoffsets of the C++ object members.
yacMemberGetTypes() : IntArray
- Return the C++ member types.
yacMetaClassInstanceOf(Object o) : boolean
- Check whether this object is an instance of meta class "o".
yacMetaClassMemberGet(int ak) : var
- Return value of meta class member.
yacMetaClassMemberGetAccessKeyByIndex(int index) : int
- Return access key to meta class member by index.
yacMetaClassMemberGetAccessKeyByName(String name) : int
- Return access key to meta class member by name.
yacMetaClassMemberGetName(int ak) : String
- Return name of meta class member associated with the given access key.
yacMetaClassMemberGetNum() : int
- Return number of meta class members.
yacMetaClassMemberGetType(int ak)
- Return meta class member type.
yacMetaClassMemberSet(int ak, Value v)
- Set value of meta class member.
yacMetaClassName() : String
- Return object meta class name.
yacMethodGetNames() : StringArray
- Return the C++ method names.
yacMethodGetNum() : int
- Return the number of C++ methods exposed to the scriptengine.
yacMethodGetNumParameters() : IntArray
- Return the number of parameters to each C++ method exposed to the scriptengine,
yacMethodGetParameterObjectTypes() : ValueArray
- Return the object parameter class names for each C++ method exposed to the scriptengine.
yacMethodGetParameterTypes() : ValueArray
- Return the parameter types arrays for each C++ method exposed to the scriptengine.
yacMethodGetReturnObjectTypes() : StringArray
- Return the return object classnames for each C++ method exposed to the scriptengine.
yacMethodGetReturnTypes() : IntArray
- Return the return types for each C++ method exposed to the scriptengine.
yacNew() : Object
- Return a new instance of this class and initializes it.
yacNewObject() : Object
- Return a new instance of this class.
yacOperator(int cmd, Object o) : var
- Invoke operator.
yacOperatorAdd(Object o)
- Add other object "o" to this object.
yacOperatorAssign(Object o)
- Assign other object "o" to this object.
yacOperatorClamp(Object min, max)
- Clamp this object to the given range.
yacOperatorDiv(Object o)
- Divide this object by other object "o".
yacOperatorF32(int cmd, float f) : var
- Invoke float operator.
yacOperatorI(int cmd, i) : var
- Invoke integer operator.
yacOperatorInit(Object o)
- Initialize object from other object.
yacOperatorMul(Object o)
- Multiply this object by other object "o".
yacOperatorSub(Object o)
- Subtract other object "o" from this object.
yacOperatorWrap(Object min, max)
- Wrap this object within the given range.
yacScanF32(Float r) : boolean
- Convert this object to a 32bit float and write to return
yacScanF64(Double r) : boolean
- Convert this object to a 64bit float and write to return
yacScanI32(Integer r) : boolean
- Convert this object to a 32bit integer and write to return
yacScanI64(Long r) : boolean
- Convert this object to a 64bit integer and write to return
yacSerialize(Stream ofs, boolean bTypeInfo)
- Serialize this object to the given outputstream.
yacSerializeClassName(Stream ofs)
- Serialize the class name String to the given outputstream.
yacStreamClose()
- Close the stream.
yacStreamEOF() : boolean
- Check whether the end of stream has been reached.
yacStreamGetByteOrder() : int
- Query the current byteorder.
yacStreamGetErrorCode() : int
- Return the last stream error code.
yacStreamGetErrorStringByCode(int errorCode) : String
- Returns a String representation of the given error code.
yacStreamGetOffset() : int
- Return the current stream offset.
yacStreamGetSize() : int
- Query the total stream size.
yacStreamOpenLocal(String name, int access) : boolean
- Open a local file for streaming.
yacStreamOpenLogic(String name) : boolean
- Open a file in the current PAK (.tkx) file for streaming.
yacStreamRead(Buffer r, int num) : int
- Read "num" bytes from the stream into Buffer
r.
yacStreamReadBuffer(Buffer r, int off, num, boolean resize) : int
- Read a sequence of bytes from the stream and write to Buffer
"r".
yacStreamReadF32() : float
- Read a single 32bit float from the stream.
yacStreamReadF64() : Double
- Read a single 64bit float from the stream.
yacStreamReadI16() : short
- Read a single 16bit short from the stream.
yacStreamReadI32() : short
- Read a single 32bit integer from the stream.
yacStreamReadI64() : Long
- Read a single 64bit integer from the stream.
yacStreamReadI8() : byte
- Read a single byte from the stream.
yacStreamReadLine(String r, int maxlen) : int
- Read a String from the stream and write to String
"r".
yacStreamReadObject(Object r)
- Read a single object from the stream and write to "r".
yacStreamReadString(String r) : boolean
- Read a single String from the stream and write to "r".
yacStreamSeek(int off, mode)
- Adjust stream offset.
yacStreamSetByteOrder(int byteorder)
- Set the stream byteorder.
yacStreamSetOffset(int off)
- Set the current stream offset.
yacStreamWrite(Buffer b, int num) : int
- Write a sequence of bytes to the stream.
yacStreamWriteBuffer(Buffer b, int off, len) : int
- Write a sequence of bytes to the stream.
yacStreamWriteF32(float f)
- Write a single 32bit float to the stream.
yacStreamWriteF64(Double f)
- Write a single 64bit float to the stream.
yacStreamWriteI16(short s)
- Write a single 16bit short to the stream.
yacStreamWriteI32(int i)
- Write a single 32bit integer to the stream.
yacStreamWriteI64(Long i)
- Write a single 64bit integer to the stream.
yacStreamWriteI8(byte b)
- Write a single byte to the stream.
yacStreamWriteString(String s, int off, len) : int
- Write a sequence of characters to the stream.
yacToParsableString(String r) : boolean
- Convert this object to a script-parsable String and write to return object "r".
yacToString(String r) : boolean
- Convert this object to a String and write to return object "r".
yacValueOfF32(float f)
- Initialize from 32bit float value.
yacValueOfI(int i)
- Initialize from 32bit integer value.ObjectArray
- A homogenous array of objects.
add(Object o) : boolean
- Add the given object value to this arraylist.
alloc(int max) : boolean
- Allocate the given number of array elements.
containsObject(Object o) : boolean
- Check whether array contains an object that equals the given object.
containsPointer(Object o) : boolean
- Check whether array contains the given object address.
delete(int index) : boolean
- Delete the array element at the given index.
empty()
- Reset the number of used elements, numElements, to 0.
free()
- Free all array elements
get(int index) : Object
- Return a reference to array element at the given index.
getDeref(int index) : Object
- Return a deletable reference to array elements at the given index.
getFirst() : Object
- Return first array element.
getLast() : Object
- Return last used array element.
getMaxElements() : int
- Return the total number of elements.
getNextFree() : Object
- Return a reference to the next free object.
getNumElements() : int
- Return the number of used elements.
getString() : String
- Return a string representation of this ObjectArray.
getTemplate() : Object
- Return the template object that is currently being used for allocations of new objects.
indexOfObject(Object o) : int
- Return the index of the element that equals the given object.
indexOfPointer(Object o) : int
- Return the index of the element that points to the given object.
insert(int index, Object o) : boolean
- Insert the given object before the given index.
realloc(int max) : boolean
- Reallocate array.
remove(Object o) : boolean
- Delete the first element whose object pointer equals the given pointer.
reverse()
- Reverse the element order.
setNumElements(int num)
- Set the number of used array elements.
setTemplate(Object template)
- Set the template object to use for allocation of new array objects.
swap(int indexA, indexB) : boolean
- Swap two array elements
useAll()
- Mark all array elements used, i.e. set numElements = maxElements.PakFile
- Represents a file in a .tkx
resp. .tsl
archive.
close()
- Close the current file.
isOpen() : boolean
- Check whether the last open()
call has succeeded.
open(String name) : boolean
- Open a file in the current application pak file (.tkx
resp. .tsl
).PointerArray
- An heterogenous array of objects.
add(Object o) : boolean
- Add the given object to the arraylist.
alloc(int max) : boolean
- Allocate the given number of array elements.
containsObject(Object o) : boolean
- Check whether array contains an object that equals the given object.
containsPointer(Object o) : boolean
- Check whether array contains the given object address.
delete(int index)
- Delete the element at the given index.
empty()
- Reset the number of used elements, numElements, to 0.
free()
- Free array elements.
get(int index) : Object
- Return a reference to the given array element.
getDeref(int index) : Object
- Return a (deletable) reference to the given array element.
getFirst() : Object
- Return first array element.
getLast() : Object
- Return last used array element.
getMaxElements() : int
- Return the total number of elements.
getNextFree() : Object
- Return a reference to the next free array element.
getNumElements() : int
- Return the number of used elements.
getString() : String
- Return a string representation of this array.
indexOfObject(Object o) : int
- Return the index of the element that equals the given object.
indexOfPointer(Object o) : int
- Return the index of the element that points to the given object.
insert(int index, Object o) : boolean
- Insert the given object into the arraylist.
joinArrays(Object a, b, boolean bCopyA, bCopyB, bUnlinkA, bUnlinkB) : boolean
- Join arrays 'a' and 'b'.
joinCC(Object a, b) : boolean
- Join arrays a and b. Copy elements.
joinCD(Object a, b) : boolean
- Join arrays a and b. Copy 'A' elements, dereference 'B' elements.
joinCR(Object a, b) : boolean
- Join arrays a and b. Copy 'A' elements, reference 'B' elements.
joinDC(Object a, b) : boolean
- Join arrays a and b. Dereference 'A' elements, copy 'B' elements.
joinDD(Object a, b) : boolean
- Join arrays a and b. Dereference elements.
joinDR(Object a, b) : boolean
- Join arrays a and b. Dereference 'A' elements, reference 'B' elements.
joinRC(Object a, b) : boolean
- Join arrays a and b. Reference 'A' elements, copy 'B' elements.
joinRD(Object a, b) : boolean
- Join arrays a and b. Reference 'A' elements, dereference 'B' elements.
joinRR(Object a, b) : boolean
- Join arrays a and b. Reference elements.
realloc(int max) : boolean
- Resize array.
remove(Object o) : boolean
- Remove the given object from the arraylist.
reverse()
- Reverse element order.
setNumElements(int num)
- Set the number of used elements.
swap(int indexA, indexB) : boolean
- Swap two array elements.
useAll()
- Mark all array elements used, i.e. set numElements = maxElements.Pool
- Manages a fixed number of homogenous objects.
alloc(int num) : boolean
-
empty()
-
free()
-
getIDByObject(Object o) : int
-
getMaxElements() : int
-
getNumElements() : int
-
getTemplate() : Object
-
qAlloc() : int
-
qFree() : int id
-
qFreeByObject(Object o)
-
setTemplate(Object o)
- Script
- Represents a dynamically loaded/compiled script.
eval()
-
findFunction(String name) : Function
-
findVariable(String name) : Variable
-
load(String script) : boolean
-
unload()
- SharedBuffer
- A shared memory buffer
allocSharedMemory(int size) : boolean
- Create shared memory key (name) and allocate the given number of bytes.
allocSharedMemoryByKey(String key, int size) : boolean
- Allocate shared memory using the given key (name).
getSharedMemoryKey() : String
- Return a (non-deletable) reference to the shared memory key (name).
visitSharedMemory(String key, int size)
- Open an already existing shared memory area using the given key (name) and size.Short
- A number object that wraps a signed 16bit integer value.
getString() : String
- Return a string representation of this number object.
getValue() : short
- Return the current value.
New(short v) : Short
- Create a new Short object and initialize it with the given value.
operator !=(int v) : boolean
- Check whether the given value does not equal this value
operator &(int v) : Short
- Calculate reminder of this divided by the given value
operator &(int v) : Short
- Bitwise AND
operator &&(int v) : boolean
- Logical AND
operator >(int v) : boolean
- Check whether this value is greater than the given value
operator >>(int v) : Short
- Logical shift right
operator >=(int v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(int v) : boolean
- Check whether this value is less than the given value
operator <<(int v) : Short
- Logical shift left
operator <=(int v) : boolean
- Check whether this value is less than the given value
operator *(int v) : Short
- Multiply by the given value
operator +(int v) : Short
- Add the given value
operator -(int v) : Short
- Subtract the given value
operator /(int v) : Short
- Divide by the given value
operator ==(int v) : boolean
- Compare to the given value
operator unary!() : Short
- Logical not
operator unary-() : Short
- Negate value
operator unary~() : Short
- Bitwise not
operator ^(int v) : Short
- Bitwise EOR/XOR (exclusive or)
operator ^^(int v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(int v) : Short
- Bitwise OR
operator ||(int v) : boolean
- Logical OR
printf(String fmt) : String
- Return a string representation of this number object that is formatted using the given ANSI-C format string.
setValue(short v)
- Set a new value.Stack
- A LIFO stack of objects.
getIndex() : int
-
getSize() : int
-
getTemplate() : Object
-
init(Object template, int size)
-
pop() : Object
-
push() : Object
-
setIndex(int index)
-
setSize(int size)
-
setTemplate(Object o)
- StdErrStream
- Represents the stderr output stream.
flush()
- Write pending/cached output buffers into the stream.
isOpen() : boolean
- Check whether the stream is open (always true).StdInStream
- Represents the stdin input stream.
isOpen() : boolean
- Check whether the stream is open (always true).StdOutStream
- Represents the stdout output stream.
flush()
- Write pending/cached output buffers into the stream.
isOpen() : boolean
- Check whether the stream is open (always true).Stream
- Base class for input/output stream objects.
close()
-
deserialize(Object o, boolean bTypeInfo) : boolean
-
eof() : boolean
-
getB8() : boolean
- Read 8bit boolean from stream (either 1 or 0).
getByteOrder() : int
-
getErrorCode() : int
-
getErrorStringByCode(int errorCode) : String
-
getF32() : float
-
getF64() : float
- @todo Make it return a Double object
getI16() : short
- Read unsigned short from stream.
getI32() : int
-
getI8() : byte
- Read unsigned byte from stream.
getObject(Object dest)
-
getOffset() : int
-
getS16() : short
- Read signed short from stream (extend to int).
getS8() : byte
- Read signed byte from stream (extend to int).
getSize() : int
-
getU16() : short
- Read unsigned short from stream.
getU8() : byte
- Read unsigned byte from stream.
readBuffer(Buffer buf, int off, num, boolean bResize) : int
-
readLine(String s, int max) : boolean
-
readString(String s, int num) : boolean
-
seek(int off, mode)
-
serialize(Object src, boolean bTypeInfo)
-
setByteOrder(int byteOrder)
-
setF32(float v)
-
setF64(float v)
- @todo make this method take a Double object argument
setI16(short v)
-
setI32(int v)
-
setI8(byte v)
-
setObject(Object src)
-
setOffset(int offset)
-
writeBuffer(Buffer buf, int off, num) : boolean
-
writeString(String s, int off, num) : boolean
- String
- A buffered String class that can handle ASCII character sequences.
abbrev(int length) : String
- This method supports the => operator.
alloc(int bufSize)
-
append(String s) : String
- This method supports the => operator.
charsetIndexOf(String charset, int off) : int
-
compare(String s) : boolean
-
compareIgnoreCase(String s) : boolean
-
copy(Object o)
-
deleteRegion(int off, len) : String
- This method supports the => operator.
empty()
-
endsWith(String s) : boolean
-
escapeControlChars()
- Replace control characters and "' by escape sequences
fixLength()
-
free()
-
freeStack()
-
getc(int offset) : char
-
getChecksum() : int
- Return checksum for the given String.
getDebugString() : String
-
getDirName() : String
- Return directory part of file.
getLength() : int
-
getWord(int wordNr) : String
-
indexOf(String s, int off) : int
-
indexOfChar(char c, int off) : int
-
indexOfControlCharacter(char c) : int
-
indexOfWordEnd(int off) : int
-
indexOfWordStart(int off) : int
-
insert(int index, String s) : String
- This method supports the => operator.
isBlank() : boolean
-
lastIndexOf(String s) : int
-
load(String fileName, boolean bRemoveCR) : boolean
-
loadLocal(String fileName, boolean bRemoveCR) : boolean
-
New(String s) : String
-
numIndicesOf(String s) : int
-
parseXML() : TreeNode
-
patternMatch(String pattern) : int
-
putc(int offset, char c)
-
realloc(int bufSize) : boolean
-
replace(String a, b)
- Replace all occurences of String a by String b.
replaceChar(char a, b) : String
- This method supports the => operator.
replaceCharReturnNum(char a, b) : int
-
replaceIncludes(String optFilePrefix) : int
-
replaceRegion(int startOff, endOff, String s) : String
- This method supports the => operator.
replaceReturnNum(String a, b) : int
-
resubstEscapeSeq()
- Replace internal escape sequences by ASCII-style ones.
resubstEscapeSeq2()
- Replace internal escape sequences by script-parseable ASCII-style ones.
revIndexOfChar(char c, int off) : int
-
saveLocal(String fileName) : boolean
-
split(char delimiter) : int
-
splitChar(char delimiter) : StringArray
- This method supports the => operator.
splitCharset(String delimiterCharset) : StringArray
- This method supports the => operator.
splitSpace(boolean bQuotes) : StringArray
- This method supports the => operator.
startsWith(String s) : boolean
-
substEscapeSeq()
- Replace ASCII-style escape sequences by internal ones.
substring(int off, len) : String
- This method supports the => operator
toLower() : String
- This method supports the => operator.
toUpper() : String
- This method supports the => operator.
trim() : String
- This method supports the => operator.
visit(String s, int off, len)
-
words(boolean bQuotes) : int
- String128
- A String that can store 128 characters without (re-)allocation.
String16
- A String that can store 16 characters without (re-)allocation.
String32
- A String that can store 32 characters without (re-)allocation.
String64
- A String that can store 64 characters without (re-)allocation.
String8
- A String that can store 8 characters without (re-)allocation.
StringArray
- An arraylist of Strings.
add(String s) : boolean
- Add a copy of the given string to this arraylist.
addEmpty(int num) : int
- Increase the number of used elements.
alloc(int max) : boolean
- Allocate the given number of array elements.
containsObject(String s) : boolean
- Check whether this array contains the given String. @yacEquals is used to compare to the given string.
containsPointer(String s) : boolean
- Check whether this array contains the given String address.
delete(int index) : boolean
- Delete element at the given index.
empty()
- Reset the number of used elements, numElements, to 0.
free()
- Free all array elements.
get(int index) : String
- Return a reference to an array element.
getCopy(int index) : String
- Return a copy of an array element.
getFirst() : Object
- Return first array element.
getLast() : Object
- Return last used array element.
getMaxElements() : int
- Return the total number of elements
getNextFree() : String
- Return next free String.
getNumElements() : int
- Return the number of used elements.
getString() : String
- Return string representation of this array.
indexOfObject(Object o) : int
- Return the index of the element that equals the given object.
indexOfPointer(Object o) : int
- Return the index of the element that points to the given object.
insert(int index, String s) : boolean
- Insert a copy of the given String into this array.
join(Object a, b)
- Join arrays 'a' and 'b'.
realloc(int max) : boolean
- Reallocate array.
rearrange(IntArray order) : boolean
- Rearrange array elements according to given order array.
reverse()
- Reverse element order.
setNumElements(int num)
- Set number of used elements.
sortByLength(IntArray order)
- Sort strings by length and write new element order to "order".
sortByValue(IntArray order, boolean bCaseSensitive)
- Sort strings by content and write new element order to "order".
swap(int indexA, indexB) : boolean
- Swap two array elements.
unset()
- Empty all Strings
useAll()
- Mark all array elements used, i.e. set numElements = maxElements.StringIterator
- Used to iterate a String word stack.
begin(String s)
-
end()
-
getCurrent() : String
-
head()
-
next() : int
-
previous() : int
-
tail() : int
- Thread
- Represents a simultaneously running program task.
allocEventQueue(int size)
- Allocate mailbox event queue/ring buffer.
create(Function entryFunction) : boolean
-
getId() : int
-
getName() : String
-
getPriority() : int
-
getUserData() : Object
-
isRunning() : boolean
-
kill()
-
peekEvent() : Event
- Return next pending event without removing it from the queue.
peekEventById(int id) : Event
- Return next pending event whose id matches "id" without removing it from the queue.
sendEvent(Event ev)
- Post new message in mailbox.
setAffinityMask32(int mask)
-
setName(String name)
-
setPriority(int prio)
-
setUserData(Object o)
-
wait() : int
-
waitEvent(int timeout) : Event
- Return next pending event or wait for new event to arrive.
waitEventById(int id, timeout, ) : Event
- Return next pending event whose id matches "id" or wait for new matching event to arrive. int
THREAD_PRIORITY_ABOVE_NORMAL
-
int
THREAD_PRIORITY_BELOW_NORMAL
-
int
THREAD_PRIORITY_HIGHEST
-
int
THREAD_PRIORITY_IDLE
-
int
THREAD_PRIORITY_LOWEST
-
int
THREAD_PRIORITY_NORMAL
-
int
THREAD_PRIORITY_TIME_CRITICAL
-
Time
- A utility class to handle time stamps. Provides date conversion.
calc()
-
getHour() : int
-
getMin() : int
-
getMonth() : int
-
getMonthday() : int
-
getNanoSec() : int
-
getSec() : int
-
getUtime() : int
-
getWeekday() : int
-
getYear() : int
-
getYearDay() : int
-
gmtime()
-
localtime()
-
now()
-
setHour(int h)
-
setMin(int min)
-
setMonth(int m)
-
setMonthday(int md)
-
setNanoSec(int ns)
-
setSec(int s)
-
setUtime(int u)
-
setYear(int yr)
- TKS
- Static class that provides various TkScript related utility functions (e.g. reflection helpers).
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
-
TreeNode
- An L/R tree that can store arbitrary user data along with a String identifier.
findById(String id, int depth) : TreeNode
- Find TreeNode by id.
findByName(String name, int depth) : TreeNode
- Find TreeNode by type name
free()
-
getId() : String
-
getLeft() : TreeNode
-
getName() : String
-
getNumNodes() : int
-
getParent() : TreeNode
-
getRight() : TreeNode
-
getRoot() : TreeNode
-
insertLeft(Object o) : TreeNode
- Insert a copy of the given object into the tree.
insertRight(Object o) : TreeNode
- Insert a copy of the given object into the tree.
seekByPathName(String pathName) : TreeNode
-
setId(String id)
-
setLeft(TreeNode n)
-
setName(String name)
-
setRight(TreeNode n)
-
writeToHashTable(HashTable ht)
- UnsignedByte
- A number object that wraps an unsigned 8bit integer value.
getString() : String
- Return a string representation of this number object.
getValue() : byte
- Return the current value.
New(byte v) : UnsignedByte
- Create a new UnsignedByte object and initialize it with the given value.
operator !=(int v) : boolean
- Check whether the given value does not equal this value
operator &(int v) : UnsignedByte
- Calculate reminder of this divided by the given value
operator &(int v) : UnsignedByte
- Bitwise AND
operator &&(int v) : boolean
- Logical AND
operator >(int v) : boolean
- Check whether this value is greater than the given value
operator >>(int v) : UnsignedByte
- Logical shift right
operator >=(int v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(int v) : boolean
- Check whether this value is less than the given value
operator <<(int v) : UnsignedByte
- Logical shift left
operator <=(int v) : boolean
- Check whether this value is less than the given value
operator *(int v) : UnsignedByte
- Multiply by the given value
operator +(int v) : UnsignedByte
- Add the given value
operator -(int v) : UnsignedByte
- Subtract the given value
operator /(int v) : UnsignedByte
- Divide by the given value
operator ==(int v) : boolean
- Compare to the given value
operator unary!() : UnsignedByte
- Logical not
operator unary-() : UnsignedByte
- Negate value
operator unary~() : UnsignedByte
- Bitwise not
operator ^(int v) : UnsignedByte
- Bitwise EOR/XOR (exclusive or)
operator ^^(int v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(int v) : UnsignedByte
- Bitwise OR
operator ||(int v) : boolean
- Logical OR
printf(String fmt) : String
- Return a string representation of this number object that is formatted using the given ANSI-C format string.
setValue(byte v)
- Set a new value.UnsignedInteger
- A number object that wraps an unsigned 32bit integer value.
getString() : String
- Return a string representation of this number object.
getValue() : int
- Return the current value.
New(int v) : UnsignedInteger
- Create a new UnsignedInteger object and initialize it with the given value.
operator !=(int v) : boolean
- Check whether the given value does not equal this value
operator &(int v) : UnsignedInteger
- Calculate reminder of this divided by the given value
operator &(int v) : UnsignedInteger
- Bitwise AND
operator &&(int v) : boolean
- Logical AND
operator >(int v) : boolean
- Check whether this value is greater than the given value
operator >>(int v) : UnsignedInteger
- Logical shift right
operator >=(int v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(int v) : boolean
- Check whether this value is less than the given value
operator <<(int v) : UnsignedInteger
- Logical shift left
operator <=(int v) : boolean
- Check whether this value is less than the given value
operator *(int v) : UnsignedInteger
- Multiply by the given value
operator +(int v) : UnsignedInteger
- Add the given value
operator -(int v) : UnsignedInteger
- Subtract the given value
operator /(int v) : UnsignedInteger
- Divide by the given value
operator ==(int v) : boolean
- Compare to the given value
operator unary!() : UnsignedInteger
- Logical not
operator unary-() : UnsignedInteger
- Negate value
operator unary~() : UnsignedInteger
- Bitwise not
operator ^(int v) : UnsignedInteger
- Bitwise EOR/XOR (exclusive or)
operator ^^(int v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(int v) : UnsignedInteger
- Bitwise OR
operator ||(int v) : boolean
- Logical OR
printf(String fmt) : String
- Return a string representation of this number object that is formatted using the given ANSI-C format string.
setValue(int v)
- Set a new value.UnsignedLong
- A number object that wraps an unsigned 64bit integer value.
getString() : String
- Return a string representation of this number object.
getValue() : int
- Return the current value.
Newi(int v) : UnsignedLong
- Create a new UnsignedLong object and initialize it with the given value.
News(String s) : UnsignedLong
- Create a new UnsignedLong object and initialize it with the given String.
operator !=(UnsignedLong v) : boolean
- Check whether the given value does not equal this value
operator &(UnsignedLong v) : UnsignedLong
- Calculate reminder of this divided by the given value
operator &(UnsignedLong v) : UnsignedLong
- Bitwise AND
operator &&(UnsignedLong v) : boolean
- Logical AND
operator >(UnsignedLong v) : boolean
- Check whether this value is greater than the given value
operator >>(UnsignedLong v) : UnsignedLong
- Logical shift right
operator >=(UnsignedLong v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(UnsignedLong v) : boolean
- Check whether this value is less than the given value
operator <<(UnsignedLong v) : UnsignedLong
- Logical shift left
operator <=(UnsignedLong v) : boolean
- Check whether this value is less than the given value
operator *(UnsignedLong v) : UnsignedLong
- Multiply by the given value
operator +(UnsignedLong v) : UnsignedLong
- Add the given value
operator -(UnsignedLong v) : UnsignedLong
- Subtract the given value
operator /(UnsignedLong v) : UnsignedLong
- Divide by the given value
operator ==(UnsignedLong v) : boolean
- Compare to the given value
operator unary!() : UnsignedLong
- Logical not
operator unary-() : UnsignedLong
- Negate value
operator unary~() : UnsignedLong
- Bitwise not
operator ^(UnsignedLong v) : UnsignedLong
- Bitwise EOR/XOR (exclusive or)
operator ^^(UnsignedLong v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(UnsignedLong v) : UnsignedLong
- Bitwise OR
operator ||(UnsignedLong v) : boolean
- Logical OR
printf(String fmt) : String
- Return a string representation of this number object that is formatted using the given ANSI-C format string.
setValue(int v)
- Set a new value.UnsignedShort
- A number object that wraps an unsigned 16bit integer value.
getString() : String
- Return a string representation of this number object.
getValue() : short
- Return the current value.
New(short v) : UnsignedShort
- Create a new UnsignedShort object and initialize it with the given value.
operator !=(int v) : boolean
- Check whether the given value does not equal this value
operator &(int v) : UnsignedShort
- Calculate reminder of this divided by the given value
operator &(int v) : UnsignedShort
- Bitwise AND
operator &&(int v) : boolean
- Logical AND
operator >(int v) : boolean
- Check whether this value is greater than the given value
operator >>(int v) : UnsignedShort
- Logical shift right
operator >=(int v) : boolean
- Check whether this value is equal to or greater than the given value
operator <(int v) : boolean
- Check whether this value is less than the given value
operator <<(int v) : UnsignedShort
- Logical shift left
operator <=(int v) : boolean
- Check whether this value is less than the given value
operator *(int v) : UnsignedShort
- Multiply by the given value
operator +(int v) : UnsignedShort
- Add the given value
operator -(int v) : UnsignedShort
- Subtract the given value
operator /(int v) : UnsignedShort
- Divide by the given value
operator ==(int v) : boolean
- Compare to the given value
operator unary!() : UnsignedShort
- Logical not
operator unary-() : UnsignedShort
- Negate value
operator unary~() : UnsignedShort
- Bitwise not
operator ^(int v) : UnsignedShort
- Bitwise EOR/XOR (exclusive or)
operator ^^(int v) : boolean
- Logical EOR/XOR (exclusive OR)
operator |(int v) : UnsignedShort
- Bitwise OR
operator ||(int v) : boolean
- Logical OR
printf(String fmt) : String
- Return a string representation of this number object that is formatted using the given ANSI-C format string.
setValue(short v)
- Set a new value.Value
- An object container for arbitrary script values.
derefObjectValue() : var
-
getDeref() : var
-
getFloatValue() : float
-
getIntValue() : int
-
getObjectValue() : Object
-
getString() : String
-
getStringValue() : String
-
getType() : int
-
getValue() : var
-
initNull()
-
initVoid()
-
isDeletable() : boolean
- Check whether the associated object value is deletable.
setFloatValue(float f)
-
setIntValue(int i)
-
setNewObject(Object template) : Object
-
setObjectValue(Object o)
-
setStringValue(String s)
-
setValue(Value value)
-
typecast(int type)
-
unlinkObject() : var
- Unlink deletable object pointer from value container.
unset()
-
yacOperatorAssign(Object o)
- int
YAC_TYPE_FLOAT
- Script type id (2) for 32bit single precision IEEE floating point values.
int
YAC_TYPE_INT
- Script type id (1) for 32bit signed integer values.
int
YAC_TYPE_OBJECT
- Script type id (3) for object pointer values.
int
YAC_TYPE_STRING
- Script type id (4) for string values.
int
YAC_TYPE_VOID
- Script type id (0) for void values.
ValueArray
- An array of dynamically typed script values.
alloc(int max) : boolean
- Allocate the given number of array elements.
containsObject(Object o) : boolean
- Check whether array contains an object that equals the given object.
containsPointer(Object o) : boolean
- Check whether array contains the given object address.
empty()
- Reset number of elements.
free()
- Free all array elements.
get(int index) : var
- Return the given array element.
getDeref(int index) : var
- Return the given (deletable) array element.
getFirst() : var
- Return first array element.
getLast() : var
- Return last used array element.
getMaxElements() : int
- Return the total number of elements.
getNumElements() : int
- Return the number of used elements, numElements.
getString() : String
- Return a string representation of this array.
indexOfObject(Object o) : int
- Return the index of the element that equals the given object.
indexOfPointer(Object o) : int
- Return the index of the element that points to the given object.
joinArrays(Object a, b, boolean bCopyA, bCopyB, bUnlinkA, bUnlinkB) : boolean
- Join arrays 'a' and 'b'.
joinCC(Object a, b) : boolean
- Join arrays a and b. Copy elements.
joinCD(Object a, b) : boolean
- Join arrays a and b. Copy 'A' elements, dereference 'B' elements.
joinCR(Object a, b) : boolean
- Join arrays a and b. Copy 'A' elements, reference 'B' elements.
joinDC(Object a, b) : boolean
- Join arrays a and b. Dereference 'A' elements, copy 'B' elements.
joinDD(Object a, b) : boolean
- Join arrays a and b. Dereference elements.
joinDR(Object a, b) : boolean
- Join arrays a and b. Dereference 'A' elements, reference 'B' elements.
joinRC(Object a, b) : boolean
- Join arrays a and b. Reference 'A' elements, copy 'B' elements.
joinRD(Object a, b) : boolean
- Join arrays a and b. Reference 'A' elements, dereference 'B' elements.
joinRR(Object a, b) : boolean
- Join arrays a and b. Reference elements.
realloc(int max) : boolean
- Resize array.
reverse()
- Reverse element order
setNumElements(int num)
- Set the number of used elements.
swap(int indexB) : boolean
- Swap two array elements.
useAll()
- Mark all array elements used, i.e. set numElements = maxElements.Variable
- Represents a script variable.
getName() : String
-
query() : boolean
-
store() : boolean
-
storeDeref()
- Function ceil | ||||||||||
Round to next bigger integer | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Function exit | |||||
Exit with the given return code | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Function floor | ||||||||||
Round to next smaller integer | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Function GetCurrentThread | |||||
Query current thread object | |||||
Signature | |||||
| |||||
Returns | |||||
Description | |||||
TkScript must have been compiled with thread local storage support (HAVE_TLS) or this function will always return null. |
Function getenv | ||||
Get environment variable | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
Description | ||||
This is a wrapper for the getenv() native function. |
Function lcchar | ||||||||||
Convert character to lower case | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Function mathAbsMaxf | ||||||||||||||||||||
Return absolutely bigger value | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Function mathAbsMinf | ||||||||||||||||||||
Return absolutely smaller value | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Function mathAbsMini | ||||||||||||||||||||
Return absolutely bigger value | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Function mathAbsMini | ||||||||||||||||||||
Return absolutely smaller value | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Function mathClampf | |||||||||||||||||||||||||
Clamp value to min/max range | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
|
Function mathClampi | |||||||||||||||||||||||||
Clamp value to min/max range | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
|
Function mathDistancePointPlane2d | ||||||||||||||||||||||||||||||||||||||||
Return distance of point p to infinite plane. | ||||||||||||||||||||||||||||||||||||||||
Signature | ||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||
Arguments | ||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||
Returns | ||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||
Description | ||||||||||||||||||||||||||||||||||||||||
q is a point on the plane and n is the plane normal. |
Function mathLerpf | |||||||||||||||||||||||||
Return linear interpolation of values a and b according to t (0..1) (a*(1-t)+b*t) | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
|
Function mathMaxf | ||||||||||||||||||||
Return bigger value | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Function mathMaxi | ||||||||||||||||||||
Return bigger value | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Function mathMinf | ||||||||||||||||||||
Return smaller value | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Function mathMini | ||||||||||||||||||||
Return smaller value | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Function mathPowerf | ||||||||||||||||||||
Return x raised to the power of y | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Function mathPoweri | ||||||||||||||||||||
Return x raised to the power of y | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Function mathSmoothStepf | |||||||||||||||||||||||||
Return smooth-step interpolation of values a and b according to s (0..1) (a*(1-t)+b*t, with t=(s*s*(3-2*s)) ) | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
|
Function mathWrapf | |||||||||||||||||||||||||
Wrap value around min/max range | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
|
Function mathWrapi | |||||||||||||||||||||||||
Wrap value around min/max range | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
|
Function milliSeconds | |||||
Return milliseconds since system start | |||||
Signature | |||||
| |||||
Returns | |||||
|
Function psystem | |||
Invoke system command | |||
Signature | |||
Arguments | |||
Returns | |||
|
Function putenv | ||||
Set environment variable | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
Description | ||||
This is a wrapper for the putenv() native function. |
Function srand | |||||
Set random seed | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Function ucchar | ||||||||||
Convert character to upper case | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54