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

Class core.ClassArray


Synopsis: Array of scriptclass instances.

  Base classes:
  Methods:
See also:  



Method add
Add the given scriptclass instance to this array.
Signature
add(Classc)
 :boolean
Arguments
Classc–Scriptclass instance to add. If c is a Value object, try to release the scriptclass instance pointer from the value container.
Returns
boolean–true if the scriptclass instance has been added successfully, false otherwise.
Description

The array will be resized if necessary.

See also:  


 
→ top of page
Method alloc
Allocate the given number of array elements.
Signature
alloc(intmax)
 :boolean
Arguments
intmax–Total number of elements.
Returns
boolean–true if the allocation succeeded, false otherwise.
Description

The number of used element, numElements, will be reset to 0.

See also:  


 
→ top of page
Method contains
Check whether this array contains a scriptclass instance that equals the given object.
Signature
contains(Classc)
 :boolean
Arguments
Classc–Scriptclass instance to compare to
Returns
boolean–true if the given scriptclass instance was found, false otherwise.

 
→ top of page
Method containsObject
Check whether array contains an object that equals the given object.
Signature
containsObject(Objecto)
 :boolean
Arguments
Objecto–The object to compare with. Object.yacEquals() is used for comparisons.
Returns
boolean–true if a matching object was found, false otherwise.

See also:  


 
→ top of page
Method containsPointer
Check whether array contains the given object address.
Signature
containsPointer(Objecto)
 :boolean
Arguments
Objecto–The object (address) to compare with.
Returns
boolean–true if a matching object was found, false otherwise.

See also:  


 
→ top of page
Method delete
Delete the given array element.
Signature
delete(intindex)
 :boolean
Arguments
intindex–Which element to delete
Returns
boolean–true if the given element has been deleted successfully, false otherwise.

See also:  


 
→ top of page
Method empty
Reset number of used elements, numElements, to 0.
Signature
empty()

See also:  


 
→ top of page
Method free
Free array elements.
Signature
free()

See also:  


 
→ top of page
Method get
Return the given array element.
Signature
get(intindex)
 :Class
Arguments
intindex–Which element to return
Returns
Class–Scriptclass instance
Description

Silently return null if "index" is out of bounds.

See also:  


 
→ top of page
Method getDeref
Unlink and return the given (deletable) array element.
Signature
getDeref(intindex)
 :Class
Arguments
intindex–Which element to return
Returns
Class–(deletable) Scriptclass instance

See also:  


 
→ top of page
Method getFirst
Return first array element.
Signature
getFirst():Object
Returns
Object–First array element or null if the array is empty. Objects are returned as non-deletable references.

 
→ top of page
Method getLast
Return last used array element.
Signature
getLast():Object
Returns
Object–Last used array element (numElements - 1) or null if the array is empty. Objects are returned as non-deletable references.

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

See also:  


 
→ top of page
Method getNextFree
Return next free element.
Signature
getNextFree():Class
Returns
Class–next free Class instance or null if the arraylist is full.
Description

Increase the number of used elements, numElements.

See also:  


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

See also:  


 
→ top of page
Method getTemplate
Return the template object that is currently being used to allocate new array elements.
Signature
getTemplate():Class
Returns
Class–Scriptclass (instance)

See also:  


 
→ top of page
Method indexOfObject
Return the index of the element that equals the given object.
Signature
indexOfObject(Objecto)
 :int
Arguments
Objecto–The object to look for
Returns
int–Array index or -1 if no matching object was found in this array

See also:  


 
→ top of page
Method indexOfPointer
Return the index of the element that points to the given object.
Signature
indexOfPointer(Objecto)
 :int
Arguments
Objecto–The object pointer to look for
Returns
int–Array index or -1 if the object address was not found in this array

See also:  


 
→ top of page
Method insert
Insert the given scriptclass instance into the array.
Signature
insert(intindex,
  Classc 
  )  
 :boolean
Arguments
intindex–Where to insert the scriptclass instance
Classc–Scriptclass instance to insert. If c is a Value object, try to release the scriptclass instance pointer from the value container.
Returns
boolean–true if the scriptclassinstance has been inserted successfully, false otherwise.

See also:  


 
→ top of page
Method isEmpty
Check if array is empty (numElements == 0).
Signature
isEmpty():boolean
Returns
boolean–

 
→ top of page
Method realloc
Reallocate array elements.
Signature
realloc(intmax)
 :boolean
Arguments
intmax–Total number of elements
Returns
boolean–true if the reallocation succeeded, false otherwise.
Description

Discard/add new elements as required.

See also:  


 
→ top of page
Method remove
Delete the first element whose pointer equals the given scriptclass instance.
Signature
remove(Classc)
 :boolean
Arguments
Classc–Scriptclass instance pointer to look for.
Returns
boolean–true if the given pointer was found and the corresponding array element has been removed, false otherwise.

 
→ top of page
Method reverse
Reverse element order.
Signature
reverse()

 
→ top of page
Method setNumElements
Set number of used elements.
Signature
setNumElements(intnum)
Arguments
intnum–New number of used elements.

See also:  


 
→ top of page
Method setTemplate
Set the template object that shall be used to allocate new array elements.
Signature
setTemplate(Classsci)
Arguments
Classsci–

See also:  


 
→ top of page
Method swap
Swap two array elements.
Signature
swap(intindexA,
  intindexB 
  )  
 :boolean
Arguments
intindexA–Index of first array element
intindexB–index of second array element
Returns
boolean–true if the elements have been swapped successfully, false otherwise.

 
→ top of page
Method unlink
Return a deletable reference to array element at the given index and remove the element from this array.
Signature
unlink(Objecto)
 :Object
Arguments
Objecto–Object
Returns
Object–Deletable Object
Description
Return null if 'o' was not found in this array.

See also:  


 
→ top of page
Method useAll
Mark all array elements used, i.e. set numElements = maxElements.
Signature
useAll()

 
→ 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