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

Class core.Value

Synopsis: An object container for arbitrary script values.

  Base classes:
  Derived classes:
  Methods:
  Constants:
See also:  

Method assign
Assign value and keep original value type (typecast if necessary).
Signature
assign(Valuev)
Arguments
Valuev–

 
→ top of page
Method derefObjectValue
Signature
derefObjectValue():var
Returns
var–

 
→ top of page
Method getDeref
Signature
getDeref():var
Returns
var–

 
→ top of page
Method getFloatValue
Signature
getFloatValue():float
Returns
float–

 
→ top of page
Method getIntValue
Signature
getIntValue():int
Returns
int–

 
→ top of page
Method getObjectValue
Signature
getObjectValue():Object
Returns
Object–

 
→ top of page
Method getString
Signature
getString():String
Returns
String–

 
→ top of page
Method getStringValue
Signature
getStringValue():String
Returns
String–

 
→ top of page
Method getType
Signature
getType():int
Returns
int–

 
→ top of page
Method getValue
Signature
getValue():var
Returns
var–

 
→ top of page
Method initNull
Signature
initNull()

 
→ top of page
Method initVoid
Signature
initVoid()

 
→ top of page
Method isDeletable
Check whether the associated object value is deletable.
Signature
isDeletable():boolean
Returns
boolean–1(true) if object value is deletable, 0(false) if value is not an object or the object is not deletable.

 
→ top of page
Method isFloat
Signature
isFloat():boolean
Returns
boolean–true when value has type float

 
→ top of page
Method isInt
Signature
isInt():boolean
Returns
boolean–true when value has type int

 
→ top of page
Method isObject
Signature
isObject():boolean
Returns
boolean–true when value has type Object

 
→ top of page
Method isString
Signature
isString():boolean
Returns
boolean–true when value has type String or has type Object and object is a String

 
→ top of page
Method isVoid
Signature
isVoid():boolean
Returns
boolean–true when value has type void

 
→ top of page
Method pointerAssign
Assign/Dereference Object pointer. Both values must have type Object or String.
Signature
pointerAssign(Valuev)
Arguments
Valuev–

 
→ top of page
Method setFloatValue
Signature
setFloatValue(floatf)
Arguments
floatf–

 
→ top of page
Method setIntValue
Signature
setIntValue(inti)
Arguments
inti–

 
→ top of page
Method setNewObject
Signature
setNewObject(Objecttemplate)
 :Object
Arguments
Objecttemplate–
Returns
Object–

 
→ top of page
Method setObjectValue
Signature
setObjectValue(Objecto)
Arguments
Objecto–

 
→ top of page
Method setStringValue
Signature
setStringValue(Strings)
Arguments
Strings–

 
→ top of page
Method setValue
Signature
setValue(Valuevalue)
Arguments
Valuevalue–

 
→ top of page
Method typecast
Change object type (and update value)
Signature
typecast(inttype)
Arguments
inttype–New type (YAC_TYPE_INT = 1, YAC_TYPE_FLOAT = 2, YAC_TYPE_OBJECT = 3, YAC_TYPE_STRING = 4)

 
→ top of page
Method unlinkObject
Unlink deletable object pointer from value container.
Signature
unlinkObject():var
Returns
var–Deletable object value or regular int/float/Object value.
Description
The object will be tagged as non-deletable in this container.

 
→ top of page
Method unset
Signature
unset()

 
→ top of page
Method yacOperatorAssign
Signature
yacOperatorAssign(Objecto)
Arguments
Objecto–

 
→ top of page
Constant YAC_TYPE_FLOAT (int)
Script type id (2) for 32bit single precision IEEE floating point values.
Constant YAC_TYPE_INT (int)
Script type id (1) for 32bit signed integer values.
Constant YAC_TYPE_OBJECT (int)
Script type id (3) for object pointer values.
Constant YAC_TYPE_STRING (int)
Script type id (4) for string values.
Description

The string type id is more like a hint for the script engine.
Strings are just Objects, too.
Constant YAC_TYPE_VOID (int)
Script type id (0) for void values.

 
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 , 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 , mathSigmoidf , 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. Sun, 4/Oct/2026 11:15:07