Documentation things

Here I'm going to poste suggestions for the documentation which although complete still deserves some polish.


DrawImage_Rotate ( slot, x, y, angle )

Draws an image to the current canvas rotated by a given angle given in degree.

Example:



DrawImage_Blit ( slot, x, y, src_x, src_y, src_w, src_h)

Draws a portion of an image to the current canvas.

Example:
    DrawImage_Blit ( 0, 20, 20, 0, 0, 50, 50 )

Draws image of slot 0 with a width of 50 and height of 50 pixel at position 20 pixel canvas width and 20 pixel canvas height.

Can also be applied to display parts of an image – for effects like walking movement :

i = 0

while true

i = i +1

if i = 4 then
i = 0
end if

DrawImageBlit(0,20,20,i*50,0,200,50)

if key(k_escape)
end
end if

wend

FPrint ( txt$ )

Outputs a string without an automatic new-line

Example:

a$ = „Hello World“

fprint(a$)


if numbers, number variables or string variables are put within the same fprint a plus sign is put inbetween


a = 4
a$ = "four"
fprint( 4 + " times\n")
fprint(a$ + " times\n")
fprint(a + " times\n")
fprint(4 + " " + a +" " + a$ + " times\n")



Frac ( n )

Returns the decimal portion of a number.

Example:
Frac(3.5)

This will return 0.5


Hex$ ( n )

Returns a hexadecimal representation of a number.

Example:

Hex$(15)

Returns f


Pop_N ( )

Returns the number on top of the number stack.

Example:

while true
push_N(4)
push_N(3)
push_N(2)
push_N(1)
push_N(0)
for n = 1 to N_stack_size()
m = pop_N()
fprint(m + “ ")
next
wait(20000)
wend

Prints 0 1 2 3 4 on console