→ index of namespace default
 
→ index of project core
 
→ index of module core

Class core.Object

Synopsis: This is the baseclass for all scriptengine objects.

  Derived classes:
  Methods: Description:


Please notice that normally you will not need to use these methodsdirectly but rather through specialized API classes like e.g. File, String, Bufferetc.These methods are mostly useful when dealing with "generic" objects but please makesure to also look at the TKS class API.


 
→ top of page
Method yacArrayAlloc
Allocate array elements.
Signature
yacArrayAlloc(intsx,
  intsy,
  inttype,
  intelementByteSize 
  )  
 :boolean
Arguments
intsx–Array width
intsy–Array height (e.g. for texture objects).
inttype–Array element type (see Value type encoding)
intelementByteSize–Size of an array element
Returns
boolean–true if elements were allocated successfully, false otherwise.
Description

Most arrays will only use the first argument ("sx").

See also:  


 
→ top of page
Method yacArrayCopySize
Copy array size from object "o".
Signature
yacArrayCopySize(Objecto)
Arguments
Objecto–Array object to copy the size from

See also:  


 
→ top of page
Method yacArrayGet
Get array element
Signature
yacArrayGet(intindex,
  Valuer 
  )  
Arguments
intindex–Array index
Valuer–Receives the element value

See also:  


 
→ top of page
Method yacArrayGetDeref
Get (deletable) array element.
Signature
yacArrayGetDeref(intindex,
  Valuer 
  )  
Arguments
intindex–Array index
Valuer–Receives the element value
Description

If the array stores a deletable object, this methodwill flag the element as non-deletable and return the deletableobject.

See also:  


 
→ top of page
Method yacArrayGetElementByteSize
Return the size of a single array element.
Signature
yacArrayGetElementByteSize():int
Returns
int–Element byte size or 0 if the size is unknown.

See also:  


 
→ top of page
Method yacArrayGetElementType
Return the array element type.
Signature
yacArrayGetElementType():int
Returns
int–Element type. The type is encoded using the Value type encoding except that 0 means variable type.

See also:  


 
→ top of page
Method yacArrayGetHeight
Return the array height.
Signature
yacArrayGetHeight():int
Returns
int–Array height

See also:  


 
→ top of page
Method yacArrayGetMaxElements
Return the total number of array elements.
Signature
yacArrayGetMaxElements():int
Returns
int–Total number of elements.

See also:  


 
→ top of page
Method yacArrayGetNumElements
Return the number of used array elements.
Signature
yacArrayGetNumElements():int
Returns
int–Number of used elements

See also:  


 
→ top of page
Method yacArrayGetStride
Return the number of bytes between two consecutive lines.
Signature
yacArrayGetStride():int
Returns
int–Number of bytes per row.
Description

This is mostly used by e.g. the texture class (see tkopengl plugin).

See also:  


 
→ top of page
Method yacArrayGetWidth
Return the array width.
Signature
yacArrayGetWidth():int
Returns
int–Array width

See also:  


 
→ top of page
Method yacArrayNew
Return new array object for this object.
Signature
yacArrayNew():Object
Returns
Object–new array object
Description

This is used to create specialized Array objects for a given object type.

See also:  


 
→ top of page
Method yacArrayRealloc
Re-allocate array elements.
Signature
yacArrayRealloc(intsx,
  intsy,
  inttype,
  intelementByteSize 
  )  
 :boolean
Arguments
intsx–Array width
intsy–Array height (e.g. for texture objects).
inttype–Array element type (see Value type encoding)
intelementByteSize–Size of an array element
Returns
boolean–true if elements were allocated successfully, false otherwise.
Description

Most arrays will only use the first argument ("sx").

See also:  


 
→ top of page
Method yacArraySet
Set array element.
Signature
yacArraySet(intindex,
  Valuev 
  )  
Arguments
intindex–Array index
Valuev–New element value

See also:  


 
→ top of page
Method yacArraySetHeight
Set the array height.
Signature
yacArraySetHeight(intsy)
Arguments
intsy–New array height

See also:  


 
→ top of page
Method yacArraySetTemplate
Set the template object to use for allocation of new array elements.
Signature
yacArraySetTemplate(Objecttemplate)
Arguments
Objecttemplate–The new array element template object
Description

This is mostly used by e.g. the ObjectArray or ClassArray classes.

See also:  


 
→ top of page
Method yacArraySetWidth
Set the array width.
Signature
yacArraySetWidth(intsx)
Arguments
intsx–New array width

See also:  


 
→ top of page
Method yacCanDeserializeClass
Check whether this class can be deserialized from the given inputstream.
Signature
yacCanDeserializeClass(Streamifs)
 :boolean
Arguments
Streamifs–Input stream.
Returns
boolean–true If this object can be deserialized from the stream, false otherwise.

See also:  


 
→ top of page
Method yacClassName
Return the class name.
Signature
yacClassName():String
Returns
String–new String instance that holds the class name
Description

Also see @yacMetaClassName.

See also:  


 
→ top of page
Method yacConstantGetNames
Return the names of the C++ constants.
Signature
yacConstantGetNames():StringArray
Returns
StringArray–new StringArray instance that holds the constant names

See also:  


 
→ top of page
Method yacConstantGetNum
Return the number of constants of a C++ class.
Signature
yacConstantGetNum():int
Returns
int–Number of constants

See also:  


 
→ top of page
Method yacConstantGetTypes
Return the types of the C++ constants.
Signature
yacConstantGetTypes():IntArray
Returns
IntArray–new IntArray that holds the constant types.
Description

The Value type encoding is used, i.e. 0=void, 1=int, 2=float, 3=Object, 4=String.

See also:  


 
→ top of page
Method yacConstantGetValues
Return the C++ constant values.
Signature
yacConstantGetValues():ValueArray
Returns
ValueArray–new ValueArray that holds the constant values.

See also:  


 
→ top of page
Method yacCopy
Copy object data from "o".
Signature
yacCopy(Objecto)
 :boolean
Arguments
Objecto–
Returns
boolean–true if copy succeded, false otherwise.

 
→ top of page
Method yacDeserialize
Deserialize object from the given inputstream.
Signature
yacDeserialize(Streamifs,
  booleanbTypeInfo 
  )  
Arguments
Streamifs–Input stream
booleanbTypeInfo–true to expect type information, false to serialize just the raw object data

See also:  


 
→ top of page
Method yacEquals
Compare this to object "o".
Signature
yacEquals(Objecto)
 :boolean
Arguments
Objecto–
Returns
boolean–true if objects are equals, false otherwise.

 
→ top of page
Method yacGetSignalStringList
Return a String that describe the signal names and callback signatures
Signature
yacGetSignalStringList():String
Returns
String–Signal string
Description
exposed by a C++ object.For an example, take a look at the tksdl plugin.

 
→ top of page
Method yacHashGet
Get a hashtable entry.
Signature
yacHashGet(Stringkey,
  Valuer 
  )  
Arguments
Stringkey–The hash key name
Valuer–Receives the hashtable entry value.

See also:  


 
→ top of page
Method yacHashGetDeref
Get (deletable) hashtable element.
Signature
yacHashGetDeref(Stringkey,
  Valuer 
  )  
Arguments
Stringkey–The hash key name
Valuer–Receives the hashtable entry value
Description

If the hashtable stores a deletable object, this methodwill flag the element as non-deletable and return the deletableobject.

See also:  


 
→ top of page
Method yacHashSet
Modify/create a hashtable entry.
Signature
yacHashSet(Stringkey,
  Valuevalue 
  )  
Arguments
Stringkey–The hash key name
Valuevalue–The element value

See also:  


 
→ top of page
Method yacInstanceOf
Check whether this C++ class is an instance of C++ class "o".
Signature
yacInstanceOf(Objecto)
 :boolean
Arguments
Objecto–Righthandside C++ object
Returns
boolean–true if this is an instance of the C++ object/class "o", false otherwise

See also:  


 
→ top of page
Method yacIsStream
Check whether object is a Stream.
Signature
yacIsStream():boolean
Returns
boolean–true if the object implements the stream interface, false otherwise.

See also:  


 
→ top of page
Method yacMemberGetNames
Return the C++ member names.
Signature
yacMemberGetNames():StringArray
Returns
StringArray–New StringArray object that holds the member names.

See also:  


 
→ top of page
Method yacMemberGetNum
Return the number of C++ members.
Signature
yacMemberGetNum():int
Returns
int–Number of C++ members.

See also:  


 
→ top of page
Method yacMemberGetObjectTypes
Return the class names of the C++ object members.
Signature
yacMemberGetObjectTypes():StringArray
Returns
StringArray–New StringArray that holds the member class names.
Description

If a member is not an Object, an empty String will be returned for that member.

See also:  


 
→ top of page
Method yacMemberGetOffsets
Return the byteoffsets of the C++ object members.
Signature
yacMemberGetOffsets():IntArray
Returns
IntArray–new IntArray instance that holds the member types

See also:  


 
→ top of page
Method yacMemberGetTypes
Return the C++ member types.
Signature
yacMemberGetTypes():IntArray
Returns
IntArray–New IntArray object that holds the member types.
Description

The Value type encoding is used, i.e. 0=void, 1=int, 2=float, 3=Object, 4=String.

See also:  


 
→ top of page
Method yacMetaClassInstanceOf
Check whether this object is an instance of meta class "o".
Signature
yacMetaClassInstanceOf(Objecto)
 :boolean
Arguments
Objecto–Righthandside object
Returns
boolean–true if this is an instance of meta class "o", false otherwise.

See also:  


 
→ top of page
Method yacMetaClassMemberGet
Return value of meta class member.
Signature
yacMetaClassMemberGet(intak)
 :var
Arguments
intak–Access key
Returns
var–Member value

See also:  


 
→ top of page
Method yacMetaClassMemberGetAccessKeyByIndex
Return access key to meta class member by index.
Signature
yacMetaClassMemberGetAccessKeyByIndex(intindex)
 :int
Arguments
intindex–Member index
Returns
int–Access key

See also:  


 
→ top of page
Method yacMetaClassMemberGetAccessKeyByName
Return access key to meta class member by name.
Signature
yacMetaClassMemberGetAccessKeyByName(Stringname)
 :int
Arguments
Stringname–Member name
Returns
int–Access key

See also:  


 
→ top of page
Method yacMetaClassMemberGetName
Return name of meta class member associated with the given access key.
Signature
yacMetaClassMemberGetName(intak)
 :String
Arguments
intak–Access key
Returns
String–Meta class member name

See also:  


 
→ top of page
Method yacMetaClassMemberGetNum
Return number of meta class members.
Signature
yacMetaClassMemberGetNum():int
Returns
int–Number of meta class members

See also:  


 
→ top of page
Method yacMetaClassMemberGetType
Return meta class member type.
Signature
yacMetaClassMemberGetType(intak)
Arguments
intak–Access key
Description

The member type is encoded using the Value type encoding.

See also:  


 
→ top of page
Method yacMetaClassMemberSet
Set value of meta class member.
Signature
yacMetaClassMemberSet(intak,
  Valuev 
  )  
Arguments
intak–Access key
Valuev–New value of meta class member

See also:  


 
→ top of page
Method yacMetaClassName
Return object meta class name.
Signature
yacMetaClassName():String
Returns
String–Meta class name
Description

This is mostly used with script classes. See Class.

See also:  


 
→ top of page
Method yacMethodGetNames
Return the C++ method names.
Signature
yacMethodGetNames():StringArray
Returns
StringArray–new StringArray object that holds the C++ method names.

See also:  


 
→ top of page
Method yacMethodGetNum
Return the number of C++ methods exposed to the scriptengine.
Signature
yacMethodGetNum():int
Returns
int–Number of C++ methods

See also:  


 
→ top of page
Method yacMethodGetNumParameters
Return the number of parameters to each C++ method exposed to the scriptengine,
Signature
yacMethodGetNumParameters():IntArray
Returns
IntArray–new IntArray object that holds the parameter counter for each method.

See also:  


 
→ top of page
Method yacMethodGetParameterObjectTypes
Return the object parameter class names for each C++ method exposed to the scriptengine.
Signature
yacMethodGetParameterObjectTypes():ValueArray
Returns
ValueArray–new ValueArray that holds the parameter class names (StringArray) for each C++ method.

See also:  


 
→ top of page
Method yacMethodGetParameterTypes
Return the parameter types arrays for each C++ method exposed to the scriptengine.
Signature
yacMethodGetParameterTypes():ValueArray
Returns
ValueArray–new ValueArray that holds the parameters types (IntArray) for each C++ method.
Description

The Value type encoding is used, i.e. 0=void, 1=int, 2=float, 3=Object, 4=String.

See also:  


 
→ top of page
Method yacMethodGetReturnObjectTypes
Return the return object classnames for each C++ method exposed to the scriptengine.
Signature
yacMethodGetReturnObjectTypes():StringArray
Returns
StringArray–new StringArray object that holds the return object classnames for each C++ method.

See also:  


 
→ top of page
Method yacMethodGetReturnTypes
Return the return types for each C++ method exposed to the scriptengine.
Signature
yacMethodGetReturnTypes():IntArray
Returns
IntArray–new IntArray object that holds the return types for each C++ method.
Description

The Value type encoding is used, i.e. 0=void, 1=int, 2=float, 3=Object with the exceptionthat the return type 4 means "variable".The last parameter to a variable return type method must be YAC_Value *_r.Methods that want to return deletable objects must also use return type 4.

See also:  


 
→ top of page
Method yacNew
Return a new instance of this class and initializes it.
Signature
yacNew():Object
Returns
Object–new Object

 
→ top of page
Method yacNewObject
Return a new instance of this class.
Signature
yacNewObject():Object
Returns
Object–new Object
Description

Warning: When instantiating script classes, yacOperatorInit() must be called afterwards.
Applications should call yacNew() instead of yacNewObject() since yacNew() takes care of script class initialization.
Alternatively, Object(myscriptclass) can be used to clone any object (including script classes).

 
→ top of page
Method yacOperator
Invoke operator.
Signature
yacOperator(intcmd,
  Objecto 
  )  
 :var
Arguments
intcmd–Command, see YAC_OP_xxx
Objecto–Righthandside object
Returns
var–Usually nothing, boolean if a comparison command was used (==, !=, ..)
Description

Usually this method returns nothing since the object is directly modified.The scriptengine takes care of duplicating the lefthandside object (this)if +,-,*,/ etc. commands are used.

See also:  


 
→ top of page
Method yacOperatorAdd
Add other object "o" to this object.
Signature
yacOperatorAdd(Objecto)
Arguments
Objecto–Righthandside object

See also:  


 
→ top of page
Method yacOperatorAssign
Assign other object "o" to this object.
Signature
yacOperatorAssign(Objecto)
Arguments
Objecto–Righthandside object

See also:  


 
→ top of page
Method yacOperatorClamp
Clamp this object to the given range.
Signature
yacOperatorClamp(Objectmin,
  Objectmax 
  )  
Arguments
Objectmin–Minimum
Objectmax–Maximum

See also:  


 
→ top of page
Method yacOperatorDiv
Divide this object by other object "o".
Signature
yacOperatorDiv(Objecto)
Arguments
Objecto–Righthandside object

See also:  


 
→ top of page
Method yacOperatorF32
Invoke float operator.
Signature
yacOperatorF32(intcmd,
  floatf 
  )  
 :var
Arguments
intcmd–Command, see YAC_OP_xxx
floatf–Righthandside float value
Returns
var–Usually nothing, boolean if a comparison command was used (==, !=, ..)
Description

Also see yacOperator()

See also:  


 
→ top of page
Method yacOperatorI
Invoke integer operator.
Signature
yacOperatorI(intcmd,
  inti 
  )  
 :var
Arguments
intcmd–Command, see YAC_OP_xxx
inti–Righthandside integer value
Returns
var–Usually nothing, boolean if a comparison command was used (==, !=, ..)
Description

Also see yacOperator()

See also:  


 
→ top of page
Method yacOperatorInit
Initialize object from other object.
Signature
yacOperatorInit(Objecto)
Arguments
Objecto–Template object
Description

This is mostly used for meta classes, e.g. to call constructors, initializemembers etc.

See also:  


 
→ top of page
Method yacOperatorMul
Multiply this object by other object "o".
Signature
yacOperatorMul(Objecto)
Arguments
Objecto–Righthandside object

See also:  


 
→ top of page
Method yacOperatorSub
Subtract other object "o" from this object.
Signature
yacOperatorSub(Objecto)
Arguments
Objecto–Righthandside object

See also:  


 
→ top of page
Method yacOperatorWrap
Wrap this object within the given range.
Signature
yacOperatorWrap(Objectmin,
  Objectmax 
  )  
Arguments
Objectmin–Minimum
Objectmax–Maximum

See also:  


 
→ top of page
Method yacScanF32
Convert this object to a 32bit float and write to return
Signature
yacScanF32(Floatr)
 :boolean
Arguments
Floatr–Receives the 32bit float value
Returns
boolean–true if the conversion succeeded, false otherwise.
Description
object "r".

See also:  


 
→ top of page
Method yacScanF64
Convert this object to a 64bit float and write to return
Signature
yacScanF64(Doubler)
 :boolean
Arguments
Doubler–Receives the 64bit float value
Returns
boolean–true if the conversion succeeded, false otherwise.
Description
object "r".

See also:  


 
→ top of page
Method yacScanI32
Convert this object to a 32bit integer and write to return
Signature
yacScanI32(Integerr)
 :boolean
Arguments
Integerr–Receives the 32bit integer value
Returns
boolean–true if the conversion succeeded, false otherwise.
Description
object "r".

See also:  


 
→ top of page
Method yacScanI64
Convert this object to a 64bit integer and write to return
Signature
yacScanI64(Longr)
 :boolean
Arguments
Longr–Receives the 64bit integer value
Returns
boolean–true if the conversion succeeded, false otherwise.
Description
object "r".

See also:  


 
→ top of page
Method yacSerialize
Serialize this object to the given outputstream.
Signature
yacSerialize(Streamofs,
  booleanbTypeInfo 
  )  
Arguments
Streamofs–Output stream
booleanbTypeInfo–true to include type information, false to serialize just the raw object data

See also:  


 
→ top of page
Method yacSerializeClassName
Serialize the class name String to the given outputstream.
Signature
yacSerializeClassName(Streamofs)
Arguments
Streamofs–Output stream

See also:  


 
→ top of page
Method yacStreamClose
Close the stream.
Signature
yacStreamClose()

See also:  


 
→ top of page
Method yacStreamEOF
Check whether the end of stream has been reached.
Signature
yacStreamEOF():boolean
Returns
boolean–true if EOF was found, false otherwise.

See also:  


 
→ top of page
Method yacStreamGetByteOrder
Query the current byteorder.
Signature
yacStreamGetByteOrder():int
Returns
int–Byteorder, YAC_LITTLEENDIAN (default) or YAC_BIGENDIAN.

See also:  


 
→ top of page
Method yacStreamGetErrorCode
Return the last stream error code.
Signature
yacStreamGetErrorCode():int
Returns
int–Error code. Except for 0=No error, the error code depends on the stream type.

See also:  


 
→ top of page
Method yacStreamGetErrorStringByCode
Returns a String representation of the given error code.
Signature
yacStreamGetErrorStringByCode(interrorCode)
 :String
Arguments
interrorCode–The stream error code
Returns
String–new String object

See also:  


 
→ top of page
Method yacStreamGetOffset
Return the current stream offset.
Signature
yacStreamGetOffset():int
Returns
int–Stream offset

See also:  


 
→ top of page
Method yacStreamGetSize
Query the total stream size.
Signature
yacStreamGetSize():int
Returns
int–Stream size or 0 (unknown)
Description

This obviously will only work for limited-size streams like e.g. File.

See also:  


 
→ top of page
Method yacStreamOpenLocal
Open a local file for streaming.
Signature
yacStreamOpenLocal(Stringname,
  intaccess 
  )  
 :boolean
Arguments
Stringname–Local filename
intaccess–0=read, 1=write, 2=read-write
Returns
boolean–true if the file has been opened, false otherwise.

See also:  


 
→ top of page
Method yacStreamOpenLogic
Open a file in the current PAK (.tkx) file for streaming.
Signature
yacStreamOpenLogic(Stringname)
 :boolean
Arguments
Stringname–Logic filename
Returns
boolean–true if the file has been opened, false otherwise.

See also:  


 
→ top of page
Method yacStreamRead
Read "num" bytes from the stream into Buffer r.
Signature
yacStreamRead(Bufferr,
  intnum 
  )  
 :int
Arguments
Bufferr–Destination Buffer
intnum–Number of bytes to read
Returns
int–Number of bytes read from Stream.

See also:  


 
→ top of page
Method yacStreamReadBuffer
Read a sequence of bytes from the stream and write to Buffer "r".
Signature
yacStreamReadBuffer(Bufferr,
  intoff,
  intnum,
  booleanresize 
  )  
 :int
Arguments
Bufferr–Destination Buffer
intoff–Destination offset in buffer
intnum–Number of bytes to read
booleanresize–If true, resize the Buffer as required
Returns
int–Number of bytes read

See also:  


 
→ top of page
Method yacStreamReadF32
Read a single 32bit float from the stream.
Signature
yacStreamReadF32():float
Returns
float–float value

See also:  


 
→ top of page
Method yacStreamReadF64
Read a single 64bit float from the stream.
Signature
yacStreamReadF64():Double
Returns
Double–float value

See also:  


 
→ top of page
Method yacStreamReadI16
Read a single 16bit short from the stream.
Signature
yacStreamReadI16():short
Returns
short–Short
Description

Perform byteorder conversion if necessary.

See also:  


 
→ top of page
Method yacStreamReadI32
Read a single 32bit integer from the stream.
Signature
yacStreamReadI32():short
Returns
short–integer value
Description

Perform byteorder conversion if necessary.

See also:  


 
→ top of page
Method yacStreamReadI64
Read a single 64bit integer from the stream.
Signature
yacStreamReadI64():Long
Returns
Long–integer value
Description

Perform byteorder conversion if necessary.

See also:  


 
→ top of page
Method yacStreamReadI8
Read a single byte from the stream.
Signature
yacStreamReadI8():byte
Returns
byte–Byte

See also:  


 
→ top of page
Method yacStreamReadLine
Read a String from the stream and write to String "r".
Signature
yacStreamReadLine(Stringr,
  intmaxlen 
  )  
 :int
Arguments
Stringr–Destination String
intmaxlen–Maximum number of chars to read
Returns
int–Number of chars read.

See also:  


 
→ top of page
Method yacStreamReadObject
Read a single object from the stream and write to "r".
Signature
yacStreamReadObject(Objectr)
Arguments
Objectr–

See also:  


 
→ top of page
Method yacStreamReadString
Read a single String from the stream and write to "r".
Signature
yacStreamReadString(Stringr)
 :boolean
Arguments
Stringr–
Returns
boolean–true if the String was read, false otherwise.

See also:  


 
→ top of page
Method yacStreamSeek
Adjust stream offset.
Signature
yacStreamSeek(intoff,
  intmode 
  )  
Arguments
intoff–Stream offset
intmode–Seek mode. YAC_BEG (0), YAC_CUR/ (1) or YAC_END (2)

See also:  


 
→ top of page
Method yacStreamSetByteOrder
Set the stream byteorder.
Signature
yacStreamSetByteOrder(intbyteorder)
Arguments
intbyteorder–YAC_LITTLEENDIAN (default) or YAC_BIGENDIAN.

See also:  


 
→ top of page
Method yacStreamSetOffset
Set the current stream offset.
Signature
yacStreamSetOffset(intoff)
Arguments
intoff–Stream offset

See also:  


 
→ top of page
Method yacStreamWrite
Write a sequence of bytes to the stream.
Signature
yacStreamWrite(Bufferb,
  intnum 
  )  
 :int
Arguments
Bufferb–Source buffer
intnum–Number of bytes to write
Returns
int–Number of bytes written

See also:  


 
→ top of page
Method yacStreamWriteBuffer
Write a sequence of bytes to the stream.
Signature
yacStreamWriteBuffer(Bufferb,
  intoff,
  intlen 
  )  
 :int
Arguments
Bufferb–Source Buffer
intoff–Source offset
intlen–Number of bytes to write
Returns
int–Number of bytes written

See also:  


 
→ top of page
Method yacStreamWriteF32
Write a single 32bit float to the stream.
Signature
yacStreamWriteF32(floatf)
Arguments
floatf–Float value to write.

See also:  


 
→ top of page
Method yacStreamWriteF64
Write a single 64bit float to the stream.
Signature
yacStreamWriteF64(Doublef)
Arguments
Doublef–Float value to write.

See also:  


 
→ top of page
Method yacStreamWriteI16
Write a single 16bit short to the stream.
Signature
yacStreamWriteI16(shorts)
Arguments
shorts–Short value to write.
Description

Automatic byteorder conversion is performed accordingto the current stream byteorder.

See also:  


 
→ top of page
Method yacStreamWriteI32
Write a single 32bit integer to the stream.
Signature
yacStreamWriteI32(inti)
Arguments
inti–
Description

Automatic byteorder conversion is performed accordingto the current stream byteorder.

See also:  


 
→ top of page
Method yacStreamWriteI64
Write a single 64bit integer to the stream.
Signature
yacStreamWriteI64(Longi)
Arguments
Longi–
Description

Automatic byteorder conversion is performed accordingto the current stream byteorder.

See also:  


 
→ top of page
Method yacStreamWriteI8
Write a single byte to the stream.
Signature
yacStreamWriteI8(byteb)
Arguments
byteb–Byte value to write

See also:  


 
→ top of page
Method yacStreamWriteString
Write a sequence of characters to the stream.
Signature
yacStreamWriteString(Strings,
  intoff,
  intlen 
  )  
 :int
Arguments
Strings–Source String
intoff–Source offset
intlen–Number of characters to write
Returns
int–Number of characters written

See also:  


 
→ top of page
Method yacToParsableString
Convert this object to a script-parsable String and write to return object "r".
Signature
yacToParsableString(Stringr)
 :boolean
Arguments
Stringr–Receives the String value
Returns
boolean–true if the conversion succeeded, false otherwise.

See also:  


 
→ top of page
Method yacToString
Convert this object to a String and write to return object "r".
Signature
yacToString(Stringr)
 :boolean
Arguments
Stringr–Receives the String value
Returns
boolean–true if the conversion succeeded, false otherwise.

See also:  


 
→ top of page
Method yacValueOfF32
Initialize from 32bit float value.
Signature
yacValueOfF32(floatf)
Arguments
floatf–Float value

See also:  


 
→ top of page
Method yacValueOfI
Initialize from 32bit integer value.
Signature
yacValueOfI(inti)
Arguments
inti–Integer value

See also:  


 
→ top of page
 
Project Modules:core 
Project Classes:Boolean , Buffer , Byte , Class , ClassArray , Condition , Configuration , Double , DummyStream , Envelope , Event , Exception , File , Float , FloatArray , FloatArray128 , FloatArray16 , FloatArray32 , FloatArray64 , FloatArray8 , Function , HashTable , IntArray , IntArray128 , IntArray16 , IntArray32 , IntArray64 , IntArray8 , Integer , LFSR , LFSR_NR , List , ListNode , Long , Mailbox , Mutex , Object , ObjectArray , PakFile , PointerArray , Pool , Process , Script , SharedBuffer , Short , Stack , StdErrStream , StdInStream , StdOutStream , Stream , String , String128 , String16 , String32 , String64 , String8 , StringArray , StringIterator , Thread , Time , TKS , TreeNode , UnsignedByte , UnsignedInteger , UnsignedLong , UnsignedShort , Value , ValueArray , Variable 
Project Functions:ceil , exit , floor , GetCurrentThread , getenv , lcchar , mathAbsMaxf , mathAbsMinf , mathAbsMini , mathAbsMini , mathCerpf , mathClampf , mathClampi , mathDistancePointPlane2d , mathFoldf , mathFoldi , mathGCD , mathLerpCyclicf , mathLerpf , mathMaxf , mathMaxi , mathMinf , mathMini , mathNextCyclicf , mathPowerf , mathPowerfC , mathPoweri , mathSerpf , mathSmoothStepf , mathSmoothStepNf , mathWrapf , mathWrapi , milliSeconds , milliSecondsDouble , psystem , putenv , srand , system , ucchar 
All Namespaces:default , graph , ui 
All Projects:core , eqxmms , ShaderVG , ShaderVG_Text , tkanalogrytm , tkchipmunk , tkclap , tkfileutils , tkfreeglut , tkfreetype2 , tkfreeverb , tkmath , tkmidi , tkmidipipe , tkminnie , tkoldmath , tkopengl , tkportaudio , tkradiastools , tksamplechain , tksampleedit , tksampler , tksdl , tksdl_net , tksidplay2 , tkspeexdsp , tksqlite , tktriangulate , tkui , tkvst2 , tkzip , ui , yingtest 

auto-generated by "DOG", the TkScript document generator. Tue, 3/Mar/2026 18:10:17