→ home
 
→ index of project core

Module core

Synopsis: 

Functions

Classes


Description:
 
Function ceil
Round to next bigger integer
Signature
ceil(floatf)
 :float
Arguments
floatf–
Returns
float–

 
→ top of page
Function exit
Exit with the given return code
Signature
exit(intreturn)
Arguments
intreturn–

 
→ top of page
Function floor
Round to next smaller integer
Signature
floor(floatf)
 :float
Arguments
floatf–
Returns
float–

 
→ top of page
Function GetCurrentThread
Query current thread object
Signature
GetCurrentThread():Thread
Returns
Thread–Current Thread object
Description

TkScript must have been compiled with thread local storage support (HAVE_TLS) or this function will always return null.
See also:  


 
→ top of page
Function getenv
Get environment variable
Signature
getenv(Stringname)
 :String
Arguments
Stringname–
Returns
String–
Description

This is a wrapper for the getenv() native function.

 
→ top of page
Function lcchar
Convert character to lower case
Signature
lcchar(charc)
 :char
Arguments
charc–
Returns
char–

 
→ top of page
Function mathAbsMaxf
Return absolutely bigger value
Signature
mathAbsMaxf(floatx,
  floaty 
  )  
 :float
Arguments
floatx–
floaty–
Returns
float–

 
→ top of page
Function mathAbsMinf
Return absolutely smaller value
Signature
mathAbsMinf(floatx,
  floaty 
  )  
 :float
Arguments
floatx–
floaty–
Returns
float–

 
→ top of page
Function mathAbsMini
Return absolutely bigger value
Signature
mathAbsMini(intx,
  inty 
  )  
 :int
Arguments
intx–
inty–
Returns
int–

 
→ top of page
Function mathAbsMini
Return absolutely smaller value
Signature
mathAbsMini(intx,
  inty 
  )  
 :int
Arguments
intx–
inty–
Returns
int–

 
→ top of page
Function mathClampf
Clamp value to min/max range
Signature
mathClampf(floata,
  floatb,
  floatt 
  )  
 :float
Arguments
floata–
floatb–
floatt–
Returns
float–

 
→ top of page
Function mathClampi
Clamp value to min/max range
Signature
mathClampi(inta,
  intb,
  intt 
  )  
 :int
Arguments
inta–
intb–
intt–
Returns
int–

 
→ top of page
Function mathDistancePointPlane2d
Return distance of point p to infinite plane.
Signature
mathDistancePointPlane2d(floatpx,
  floatpy,
  floatqx,
  floatqy,
  floatnx,
  floatny 
  )  
 :float
Arguments
floatpx–a point
floatpy–a point
floatqx–a point on the plane
floatqy–a point on the plane
floatnx–the plane normal
floatny–the plane normal
Returns
float–distance of point to plane
Description

 
q is a point on the plane and n is the plane normal.

 
→ top of page
Function mathLerpf
Return linear interpolation of values a and b according to t (0..1) (a*(1-t)+b*t)
Signature
mathLerpf(floata,
  floatb,
  floatt 
  )  
 :float
Arguments
floata–
floatb–
floatt–
Returns
float–

 
→ top of page
Function mathMaxf
Return bigger value
Signature
mathMaxf(floatx,
  floaty 
  )  
 :float
Arguments
floatx–
floaty–
Returns
float–

 
→ top of page
Function mathMaxi
Return bigger value
Signature
mathMaxi(intx,
  inty 
  )  
 :int
Arguments
intx–
inty–
Returns
int–

 
→ top of page
Function mathMinf
Return smaller value
Signature
mathMinf(floatx,
  floaty 
  )  
 :float
Arguments
floatx–
floaty–
Returns
float–

 
→ top of page
Function mathMini
Return smaller value
Signature
mathMini(intx,
  inty 
  )  
 :int
Arguments
intx–
inty–
Returns
int–

 
→ top of page
Function mathPowerf
Return x raised to the power of y
Signature
mathPowerf(floatx,
  floaty 
  )  
 :float
Arguments
floatx–
floaty–
Returns
float–

 
→ top of page
Function mathPoweri
Return x raised to the power of y
Signature
mathPoweri(intx,
  inty 
  )  
 :int
Arguments
intx–
inty–
Returns
int–

 
→ top of page
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
mathSmoothStepf(floata,
  floatb,
  floats 
  )  
 :float
Arguments
floata–
floatb–
floats–
Returns
float–

 
→ top of page
Function mathWrapf
Wrap value around min/max range
Signature
mathWrapf(floata,
  floatb,
  floatt 
  )  
 :float
Arguments
floata–
floatb–
floatt–
Returns
float–

 
→ top of page
Function mathWrapi
Wrap value around min/max range
Signature
mathWrapi(inta,
  intb,
  intt 
  )  
 :int
Arguments
inta–
intb–
intt–
Returns
int–

 
→ top of page
Function milliSeconds
Return milliseconds since system start
Signature
milliSeconds():int
Returns
int–

 
→ top of page
Function psystem
Invoke system command
Signature
psystem(Stringcmd,
  characcess,
  Stringbuf 
  )  
 :int
Arguments
Stringcmd–Command line
characcess–r to read result to buf, w to read input from buf
Stringbuf–Input resp. output buffer
Returns
int–Number of bytes read resp. written

 
→ top of page
Function putenv
Set environment variable
Signature
putenv(Stringname)
 :String
Arguments
Stringname–
Returns
String–
Description

This is a wrapper for the putenv() native function.

 
→ top of page
Function srand
Set random seed
Signature
srand(intseed)
Arguments
intseed–

 
→ top of page
Function system
Invoke system command
Signature
system(Stringcmd)
Arguments
Stringcmd–Command line

 
→ top of page
Function ucchar
Convert character to upper case
Signature
ucchar(charc)
 :char
Arguments
charc–
Returns
char–

 
→ 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 , List , ListNode , Long , Mailbox , Mutex , Object , ObjectArray , PakFile , PointerArray , Pool , 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 , mathClampf , mathClampi , mathDistancePointPlane2d , mathLerpf , mathMaxf , mathMaxi , mathMinf , mathMini , mathPowerf , mathPoweri , mathSmoothStepf , mathWrapf , mathWrapi , milliSeconds , psystem , putenv , srand , system , ucchar 
All Namespaces:default , ui 
All Projects:core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit 


 
→ top of page

auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54