Changes to sprite animation system

* Changed the names of some of the functions
* Added functions for setting and returning the projection matrix of the active camera
* Added a function for getting the 2D screen coordinates from a 3D vector
* Added documentation for all the new functions

doc/files/canvasz.txt

@@ -0,0 +1,8 @@
+#title CanvasZ [RCBasic Doc]
+#header function CanvasZ(c_num)
+
+Returns the Canvas Z Order.
+
+Note: Canvases with a higher Z order are drawn first and those with lower values will be drawn on top
+
+#ref SetCanvasZ

doc/files/createplanemesh.txt

@@ -0,0 +1,10 @@
+#title CreatePlaneMesh [RCBasic Doc]
+#header Function CreatePlaneMesh( w, h, tileCount_w, tileCount_h )
+
+Creates a flat plane
+
+#list
+#li w, h - The width and height of the plane
+#li tileCount_w, TileCount_h - The number of subdivisions across and down the plane
+#/list
+

doc/files/createspriteanimation.txt

@@ -0,0 +1,9 @@
+#title CreateSpriteAnimation [RCBasic Doc]
+#header Function CreateSpriteAnimation(sprite, anim_length, speed)
+
+Returns a new sprite animation id
+
+#list ul
+#li anim_length - number of frames in the animation
+#li speed - frames per second for the animation
+#/list

doc/files/createwateractor.txt

@@ -0,0 +1,4 @@
+#title CreateWaterActor [RCBasic Doc]
+#header function CreateWaterActor( mesh, waveHeight, waveSpeed, waveLength )
+
+Creates an actor with water properties set on a base mesh

doc/files/getan8scenename.txt

@@ -0,0 +1,4 @@
+#title GetAN8SceneName$ [RCBasic Doc]
+#header Function GetAN8SceneName$(an8_project, scene_num)
+
+Returns the name of a scene in an an8 project

doc/files/getnuman8scenes.txt

@@ -0,0 +1,6 @@
+#title GetNumAN8Scenes [RCBasic Doc]
+#header Function GetNumAN8Scenes(an8_project)
+
+Returns the number of scenes in an an8 project
+
+#ref LoadAN8

doc/files/getprojectionmatrix.txt

@@ -0,0 +1,12 @@
+#title GetProjectionMatrix [RCBasic Doc]
+#header Sub GetProjectionMatrix(matA)
+
+Gets the camera projection matrix for the active canvas
+
+Possible values for projection_type
+#list ul
+#li PROJECTION_TYPE_ORTHOGRAPHIC
+#li PROJECTION_TYPE_PERSPECTIVE
+#/list
+
+#ref SetProjectionMatrix

doc/files/getspriteanimation.txt

@@ -0,0 +1,6 @@
+#title GetSpriteAnimation [RCBasic Doc]
+#header Function GetSpriteAnimation(sprite)
+
+Returns the current animation set on a sprite
+
+#ref SetSpriteAnimation

doc/files/getspriteanimationframe.txt

@@ -0,0 +1,4 @@
+#title GetSpriteAnimationFrame [RCBasic Doc]
+#header Function GetSpriteAnimationFrame(sprite, animation, anim_frame)
+
+Returns the frame index in the image source that is set to anim_frame in a sprite's animation

doc/files/getspriteanimationlength.txt

@@ -0,0 +1,4 @@
+#title GetSpriteAnimationLength [RCBasic Doc]
+#header Function GetSpriteAnimationLength(sprite, animation)
+
+Returns the number of frames in a sprite animation

doc/files/getspriteanimationspeed.txt

@@ -0,0 +1,4 @@
+#title GetSpriteAnimationSpeed [RCBasic Doc]
+#header Function GetSpriteAnimationSpeed(sprite, animation)
+
+Returns the frames per second of a sprite animation

doc/files/getspritecurrentanimationframe.txt

@@ -0,0 +1,4 @@
+#title GetSpriteCurrentAnimationFrame [RCBasic Doc]
+#header Function GetSpriteCurrentAnimationFrame(sprite)
+
+Returns the current frame of a sprite's animation

doc/files/getspriteframe.txt

@@ -0,0 +1,4 @@
+#title GetSpriteFrame [RCBasic Doc]
+#header Function GetSpriteFrame(sprite)
+
+Returns the current frame in a sprite's source that it's on in its animation

doc/files/getspriteposition.txt

@@ -0,0 +1,6 @@
+#title GetSpritePosition [RCBasic Doc]
+#header Sub GetSpritePosition(sprite, ByRef x, ByRef y)
+
+Gets the position of a sprite on the canvas
+
+#ref TranslateSprite SetSpritePosition

doc/files/getspriterotation.txt

@@ -0,0 +1,6 @@
+#title GetSpriteRotation [RCBasic Doc]
+#header Function GetSpriteRotation(sprite)
+
+Returns the angle the sprite is rotated by
+
+#ref SetSpriteRotation RotateSprite

doc/files/getspritescale.txt

@@ -0,0 +1,6 @@
+#title GetSpriteScale [RCBasic Doc]
+#header Sub GetSpriteScale(sprite, ByRef x, ByRef y)
+
+Gets the scale of a sprite
+
+#ref ScaleSprite SetSpriteScale

doc/files/getspritesize.txt

@@ -0,0 +1,6 @@
+#title GetSpriteSize [RCBasic Doc]
+#header Sub GetSpriteSize(sprite, ByRef w, ByRef h)
+
+Gets the size of a sprite's frames
+
+#ref CreateSprite

doc/files/getspritesource.txt

@@ -0,0 +1,6 @@
+#title GetSpriteSource [RCBasic Doc]
+#header Function GetSpriteSource(sprite)
+
+Returns the source image the sprite renders its frames from
+
+#ref SetSpriteSource CreateSprite

doc/files/getspritetype.txt

@@ -0,0 +1,15 @@
+#title GetSpriteType [RCBasic Doc]
+#header Function GetSpriteType(sprite)
+
+Returns the collison body type of a sprite.
+
+By default, sprites are dynamic when they are created.
+
+Possible types returned
+#list ul
+#li SPRITE_TYPE_STATIC
+#li SPRITE_TYPE_KINEMATIC
+#li SPRITE_TYPE_DYNAMIC
+#/list
+
+#ref SetSpriteType

doc/files/getworldtoviewportposition.txt

@@ -0,0 +1,4 @@
+#title GetWorldToViewportPosition [RCBasic Doc]
+#header Sub GetWorldToViewportPosition(x, y, z, ByRef x, ByRef y)
+
+Get the 2D coordinates for the given 3D position on the active canvas

doc/files/loadan8.txt

@@ -0,0 +1,6 @@
+#title LoadAN8 [RCBasic Doc]
+#header Function LoadAN8( an8_file$ )
+
+Loads an an8 project and returns an id that can be used in LoadMeshFromAN8()
+
+#ref LoadMeshFromAN8

doc/files/loadmeshfroman8.txt

@@ -0,0 +1,8 @@
+#title LoadMeshFromAN8 [RCBasic Doc]
+#header Function LoadMeshFromAN8(an8_project, an8_scene$)
+
+Loads the figures in an anim8or scene as a mesh
+
+Note: This only loads figures from a scene and it loads meshes not anim8or objects
+
+#ref LoadAN8 LoadMesh LoadMeshFromArchive

doc/files/numspriteanimationloops.txt

@@ -0,0 +1,6 @@
+#title NumSpriteAnimationLoops [RCBasic Doc]
+#header Function NumSpriteAnimationLoops(sprite)
+
+Returns the number of animation loops the actor has set
+
+#ref SetSpriteAnimationLoops SetSpriteAnimation

doc/files/preupdate.txt

@@ -0,0 +1,8 @@
+#title PreUpdate [RCBasic Doc]
+#header Sub PreUpdate( )
+
+Processes physics for sprites and actors.
+
+This is useful if you need to know the post solve positions and rotations prior to drawing them.
+
+#ref Update

doc/files/rotatesprite.txt

@@ -0,0 +1,6 @@
+#title RotateSprite [RCBasic Doc]
+#header Sub RotateSprite(sprite, angle)
+
+Sets the angle the sprite is rotated by relative to its current rotation
+
+#ref SetSpriteRotation GetSpriteRotation

doc/files/scalesprite.txt

@@ -0,0 +1,6 @@
+#title ScaleSprite [RCBasic Doc]
+#header Sub ScaleSprite(sprite, x, y)
+
+Sets the scale of a sprite relative to its current scale
+
+#ref SetSpriteScale GetSpriteScale

doc/files/setcameraprojectionmatrix.txt

@@ -0,0 +1,12 @@
+#title SetCameraProjectionMatrix [RCBasic Doc]
+#header Sub SetCameraProjectionMatrix(matA, projection_type)
+
+Sets the camera projection matrix for the active canvas
+
+Possible values for projection_type
+#list ul
+#li PROJECTION_TYPE_ORTHOGRAPHIC
+#li PROJECTION_TYPE_PERSPECTIVE
+#/list
+
+#ref GetCameraProjectionMatrix

doc/files/setcanvasz.txt

@@ -3,6 +3,6 @@
 
 Sets the Canvas Z Order.
 
-Note: Canvases with a lower Z order are drawn first and those with higher values will be drawn on top
+Note: Canvases with a higher Z order are drawn first and those with lower values will be drawn on top
 
 #ref SetCanvasZ

doc/files/setprojectionmatrix.txt

@@ -0,0 +1,12 @@
+#title SetProjectionMatrix [RCBasic Doc]
+#header Sub SetProjectionMatrix(matA, projection_type)
+
+Sets the camera projection matrix for the active canvas
+
+Possible values for projection_type
+#list ul
+#li PROJECTION_TYPE_ORTHOGRAPHIC
+#li PROJECTION_TYPE_PERSPECTIVE
+#/list
+
+#ref GetProjectionMatrix

doc/files/setspriteanimation.txt

@@ -0,0 +1,8 @@
+#title SetSpriteAnimation [RCBasic Doc]
+#header Sub SetSpriteAnimation(sprite, animation)
+
+Sets the current animation for a sprite
+
+Note: Once an animation is set, it will automatically start
+
+#ref GetSpriteAnimation

doc/files/setspriteanimationframe.txt

@@ -0,0 +1,6 @@
+#title SetSpriteAnimationFrame [RCBasic Doc]
+#header Sub SetSpriteAnimationFrame(sprite, animation, anim_frame, frame)
+
+Sets a frame in a sprite animation
+
+#ref GetSpriteAnimationFrame

doc/files/setspriteanimationlength.txt

@@ -0,0 +1,6 @@
+#title SetSpriteAnimationLength [RCBasic Doc]
+#header Sub SetSpriteAnimationLength(sprite, animation, anim_length)
+
+Sets the number of frames in a sprite animation
+
+#ref GetSpriteAnimationLength

doc/files/setspriteanimationloops.txt

@@ -0,0 +1,6 @@
+#title SetSpriteAnimationLoops [RCBasic Doc]
+#header Sub SetSpriteAnimationLoops(sprite, num_loops)
+
+Sets the number of animation loops for the sprite
+
+#ref NumSpriteAnimationLoops

doc/files/setspriteanimationspeed.txt

@@ -0,0 +1,4 @@
+#title SetSpriteAnimationSpeed [RCBasic Doc]
+#header Sub SetSpriteAnimationSpeed(sprite, animation, speed)
+
+Sets the speed in frames per second for a sprite animation

doc/files/setspriteframe.txt

@@ -0,0 +1,4 @@
+#title SetSpriteFrame [RCBasic Doc]
+#header Sub SetSpriteFrame(sprite, frame)
+
+Sets a sprite to a frame in its frame sheet

doc/files/setspriterotation.txt

@@ -0,0 +1,7 @@
+#title SetSpriteRotation [RCBasic Doc]
+#header Sub SetSpriteRotation(sprite, angle)
+
+Sets the angle the sprite is rotated by
+
+#ref GetSpriteRotation RotateSprite
+

doc/files/setspritescale.txt

@@ -0,0 +1,6 @@
+#title SetSpriteScale [RCBasic Doc]
+#header Sub SetSpriteScale(sprite, x, y)
+
+Sets the scale of a sprite
+
+#ref ScaleSprite GetSpriteScale

doc/files/setspritesolid.txt

@@ -0,0 +1,7 @@
+#title SetSpriteSolid [RCBasic Doc]
+#header Sub SetSpriteSolid(sprite, flag)
+
+Sets whether a sprite has physics and collision response enabled
+
+#ref SpriteIsSolid
+

doc/files/setspritesource.txt

@@ -0,0 +1,8 @@
+#title SetSpriteSource [RCBasic Doc]
+#header Sub SetSpriteSource(sprite, img)
+
+Changes the image source for a sprite frame sheet
+
+Note: This needs to be the same size as the current image source or you will have rendering issues
+
+#ref GetSpriteSource

doc/files/setspritetype.txt

@@ -0,0 +1,12 @@
+#title SetSpriteType [RCBasic Doc]
+#header Sub SetSpriteType(sprite, sprite_type)
+
+Sets the type of collision body a sprite has
+
+#list ul
+#li SPRITE_TYPE_STATIC
+#li SPRITE_TYPE_KINEMATIC
+#li SPRITE_TYPE_DYNAMIC
+#/list
+
+#ref GetSpriteType

doc/files/setspritevisible.txt

@@ -0,0 +1,6 @@
+#title SetSpriteVisible [RCBasic Doc]
+#header Sub SetSpriteVisible(sprite, flag)
+
+Sets whether the sprite is visible
+
+#ref SpriteIsVisible

doc/files/setspritez.txt

@@ -0,0 +1,9 @@
+#title SetSpriteZ [RCBasic Doc]
+#header Sub SetSpriteZ(sprite, z)
+
+Sets the drawing priority for sprites.
+
+Note: Sprites with a higher Z order are drawn first and those with lower values will be drawn on top
+
+#ref SpriteZ
+

doc/files/spriteheight.txt

@@ -0,0 +1,7 @@
+#title SpriteHeight [RCBasic Doc]
+#header Function SpriteHeight(sprite)
+
+Returns the frame height of a sprite
+
+#ref SpriteWidth GetSpriteSize
+

doc/files/spriteissolid.txt

@@ -0,0 +1,6 @@
+#title SpriteIsSolid [RCBasic Doc]
+#header Function SpriteIsSolid(sprite)
+
+Returns true if a sprite is has physics and collision response enabled
+
+#ref SetSpriteSolid

doc/files/spriteisvisible.txt

@@ -0,0 +1,6 @@
+#title SpriteIsVisible [RCBasic Doc]
+#header Function SpriteIsVisible(sprite)
+
+Returns whether the sprite is visible
+
+#ref SetSpriteVisible

doc/files/spritewidth.txt

@@ -0,0 +1,6 @@
+#title SpriteWidth [RCBasic Doc]
+#header Function SpriteWidth(sprite)
+
+Returns the frame width of a sprite
+
+#ref SpriteHeight GetSpriteSize

doc/files/spritex.txt

@@ -0,0 +1,7 @@
+#title SpriteX [RCBasic Doc]
+#header Function SpriteX(sprite)
+
+Returns the X position of a sprite on a canvas
+
+#ref SpriteY SetSpritePosition GetSpritePosition
+

doc/files/spritey.txt

@@ -0,0 +1,6 @@
+#title SpriteY [RCBasic Doc]
+#header Function SpriteY(sprite)
+
+Returns the Y position of a sprite on a canvas
+
+#ref SpriteX SetSpritePosition GetSpritePosition

doc/files/spritez.txt

@@ -0,0 +1,8 @@
+#title SpriteZ [RCBasic Doc]
+#header Function SpriteZ(sprite)
+
+Returns the drawing priority for sprites.
+
+Note: Sprites with a higher Z order are drawn first and those with lower values will be drawn on top
+
+#ref SetSpriteZ

doc/files/textheight.txt

@@ -0,0 +1,7 @@
+#title TextHeight [RCBasic Doc]
+#header function TextHeight(txt$)
+
+The height of text rendered with the active font
+
+#ref TextWidth GetTextSize
+

doc/files/textwidth.txt

@@ -0,0 +1,6 @@
+#title TextWidth [RCBasic Doc]
+#header function TextWidth(txt$)
+
+The width of text rendered with the active font
+
+#ref TextHeight GetTextSize

doc/files/translatesprite.txt

@@ -0,0 +1,8 @@
+#title TranslateSprite [RCBasic Doc]
+#header Sub TranslateSprite(sprite, x, y)
+
+Move a sprite relative to its current position
+
+Note: This function sets the position of a sprite without regards to physics properties so it will not trigger collision detection or collision response.
+
+#ref SetSpritePosition GetSpritePosition