Global Functions Documentation

Functions and Properties

Return Type	Function Information
`int`	`Rand(int maxvalue)Computes and returns a random integer i such that 0 <= i < maxvalue. The return value is undefined if maxvalue is 0 or negative.`
`void`	`Quit()Terminates execution of the current script. Does not return.`
`void`	`Waitframe()Temporarily halts execution of the current script. This function returns at the beginning of the next frame of gameplay. Slots 1, 3 and 4 Global scripts and item scripts only execute for one frame, so in those scripts Waitframe() is essentially Quit(). It is safe to call Waitframe in the active global script.`
`void`	`Waitdraw()Halts execution of the script until ZC's internal code has been run (movement, collision detection, etc.), but before the screen is drawn. This can only be used in the active global script.`
`void`	`Trace(float val)Prints a line containing a string representation of val to allegro.log. Useful for debugging scripts.`
`void`	`TraceB(bool state)Prints a boolean state to allegro.log`
`void`	`TraceS(int s[])Takes the array pointer as its argument, and prints it as a string to allegro.log Maximum 512 characters. Functions from string.zh can be used to split larger strings.`
`void`	`TraceToBase(int val, int base, int mindigits)Prints a line in allegro.log representing 'val' in numerical base 'base' where 2 <= base <= 36, with minimum digits 'mindigits'. Can be useful for checking hex values or flags ORed together, or just to trace an integer value, as Trace() always traces to four decimal places.`
`void`	`TraceNL()Traces a newline to allegro.log`
`void`	`ClearTrace()Clears allegro.log of all current traces and messages from Zelda Classic/ZQuest.`
`float`	`Sin(float deg)Returns the trigonometric sine of the parameter, which is interpreted as a degree value.`
`float`	`Cos(float deg)Returns the trigonometric cosine of the parameter, which is interpreted as a degree value.`
`float`	`Tan(float deg)Returns the trigonometric tangent of the parameter, which is interpreted as a degree value. The return value is undefined if deg is of the form 90 + 180n for an integral value of n.`
`float`	`RadianSin(float rad)Returns the trigonometric sine of the parameter, which is interpreted as a radian value.`
`float`	`RadianCos(float rad)Returns the trigonometric cosine of the parameter, which is interpreted as a radian value.`
`float`	`RadianTan(float rad)Returns the trigonometric tangent of the parameter, which is interpreted as a radian value. The return value is undefined for values of rad near (pi/2) + n*pi, for n an integer.`
`float`	`ArcTan(int x, int y)Returns the trigonometric arctangent of the coordinates, which is interpreted as a radian value.`
`float`	`ArcSin(float x)Returns the trigonometric arcsine of x, which is interpreted as a radian value.`
`float`	`ArcCos(float x)Returns the trigonometric arccosine of x, which is interpreted as a radian value.`
`float`	`Max(float a, float b)Returns the greater of a and b.`
`float`	`Min(float a, float b)Returns the lesser of a and b.`
`int`	`Pow(int base, int exp)Returns base^exp. The return value is undefined for base=exp=0. Note also negative values of exp may not be useful, as the return value is truncated to the nearest integer.`
`int`	`InvPow(int base, int exp)Returns base^(1/exp). The return value is undefined for exp=0, or if exp is even and base is negative. Note also that negative values of exp may not be useful, as the return value is truncated to the nearest integer.`
`float`	`Log10(float val)Returns the log of val to the base 10. Any value <= 0 will return 0.`
`float`	`Ln(float val)Returns the natural logarithm of val (to the base e). Any value <= 0 will return 0.`
`int`	`Factorial(int val)Returns val!. val < 0 returns 0.`
`float`	`Abs(float val)Return the absolute value of the parameter, if possible. If the absolute value would overflow the parameter, the return value is undefined.`
`float`	`Sqrt(float val)Computes the square root of the parameter. The return value is undefined for val < 0.`
`void`	`CopyTile(int srctile, int desttile)Copies the tile specified by scrtile onto the tile space specified by desttile.`
`void`	`SwapTile(int firsttile, int secondtile)Swaps the two tiles specified by firsttile and secondtile.`
`void`	`ClearTile(int tileref)Erases the tile specified by tileref.`
`int`	`SizeOfArray(int array[])Returns the size of the array pointed by 'array'`