+ Returns the current font that will be used with DrawText +
+
+ test_font = LoadFont("test_font.ttf", 12)
+ SetFont(test_font)
+ If ActiveFont() = test_font Then
+ Print "Test Font is active"
+ End If
+
Related: + LoadFont + SetFont + DrawText +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/addcompositechild.html b/doc/doc_files/addcompositechild.html new file mode 100644 index 0000000..6f78325 --- /dev/null +++ b/doc/doc_files/addcompositechild.html @@ -0,0 +1,27 @@ + + + + + ++ Adds a child Actor to a composite actor. +
++ Returns the child index in the composite actor. +
++ NOTE: Reference the included Composite Demo for an example +
+Related: + CreateCompositeActor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/addprojectoreffectactor.html b/doc/doc_files/addprojectoreffectactor.html new file mode 100644 index 0000000..4cf5773 --- /dev/null +++ b/doc/doc_files/addprojectoreffectactor.html @@ -0,0 +1,27 @@ + + + + + ++ Add an effect actor from a projector. +
++ Returns the index of the effect actor in the projector. +
++ Refer to the included Projector Demo for an example +
+Related: + RemoveProjectorEffectActor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/addspritechild.html b/doc/doc_files/addspritechild.html new file mode 100644 index 0000000..8c0dff8 --- /dev/null +++ b/doc/doc_files/addspritechild.html @@ -0,0 +1,21 @@ + + + + + ++ Adds a sprite as a child to another sprite. Child sprite is offset by given position. +
+Related: + RemoveSpriteChild +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/addvehiclewheel.html b/doc/doc_files/addvehiclewheel.html new file mode 100644 index 0000000..240b93e --- /dev/null +++ b/doc/doc_files/addvehiclewheel.html @@ -0,0 +1,27 @@ + + + + + ++ Add a wheel to a vehicle actor +
++ is_front_wheel sets whether it should be considered a front wheel for physics and control +
++ NOTE: Once an actor is set as a wheel, the vehicle controls all transforms for the actor +
+Related: + CreateVehicleActor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/applywheelengineforce.html b/doc/doc_files/applywheelengineforce.html new file mode 100644 index 0000000..3dc970a --- /dev/null +++ b/doc/doc_files/applywheelengineforce.html @@ -0,0 +1,21 @@ + + + + + ++ Apply force to a wheel. +
++ NOTE: For movement, you can apply force to a vehicle the same way you apply it to any actor. Refer to the actor physics section for documentation on that. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/calculatecompositeprincipaltransform.html b/doc/doc_files/calculatecompositeprincipaltransform.html new file mode 100644 index 0000000..7caf9fa --- /dev/null +++ b/doc/doc_files/calculatecompositeprincipaltransform.html @@ -0,0 +1,35 @@ + + + + + ++ Calculates the center of mass and principal intertia axes for a composite actor. +
++ Parameters: +
+Related: + CreateCompositeActor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/clearposteffect.html b/doc/doc_files/clearposteffect.html new file mode 100644 index 0000000..16dd4dc --- /dev/null +++ b/doc/doc_files/clearposteffect.html @@ -0,0 +1,18 @@ + + + + + ++ Removes the current post effect from the canvas. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/createcompositeactor.html b/doc/doc_files/createcompositeactor.html new file mode 100644 index 0000000..c3d6bf2 --- /dev/null +++ b/doc/doc_files/createcompositeactor.html @@ -0,0 +1,24 @@ + + + + + ++ Creates a composite actor +
++ Refer to the included Composite Demo for an example +
+Related: + AddCompositeChild +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/createvehicleactor.html b/doc/doc_files/createvehicleactor.html new file mode 100644 index 0000000..846bbcc --- /dev/null +++ b/doc/doc_files/createvehicleactor.html @@ -0,0 +1,21 @@ + + + + + ++ Creates a vehicle actor. The chassis_actor is another actor that will be attached as the main body of the vehicle. +
+Related: + AddVehicleWheel +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/dotproduct.html b/doc/doc_files/dotproduct.html new file mode 100644 index 0000000..74ea766 --- /dev/null +++ b/doc/doc_files/dotproduct.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the dot product from 2 vectors +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/flipmeshsurfaces.html b/doc/doc_files/flipmeshsurfaces.html new file mode 100644 index 0000000..abfaf2d --- /dev/null +++ b/doc/doc_files/flipmeshsurfaces.html @@ -0,0 +1,18 @@ + + + + + ++ Changes the facing direction of triangles in a mesh +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/generatecompositeaabbfromchildren.html b/doc/doc_files/generatecompositeaabbfromchildren.html new file mode 100644 index 0000000..2e9ee4f --- /dev/null +++ b/doc/doc_files/generatecompositeaabbfromchildren.html @@ -0,0 +1,18 @@ + + + + + ++ Generates a bounding box based on the child actors +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getactorboneabsolutetranform.html b/doc/doc_files/getactorboneabsolutetranform.html new file mode 100644 index 0000000..6d1cae2 --- /dev/null +++ b/doc/doc_files/getactorboneabsolutetranform.html @@ -0,0 +1,21 @@ + + + + + ++ Stores the absolute transform of a bone in t_matrix +
++ NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getactorbonecount.html b/doc/doc_files/getactorbonecount.html new file mode 100644 index 0000000..cb76cd0 --- /dev/null +++ b/doc/doc_files/getactorbonecount.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the number of bones in an actor +
++ NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getactorboneindex.html b/doc/doc_files/getactorboneindex.html new file mode 100644 index 0000000..f4f19e6 --- /dev/null +++ b/doc/doc_files/getactorboneindex.html @@ -0,0 +1,21 @@ + + + + + ++ Returns a bone index based on its name +
++ NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getactorbonename.html b/doc/doc_files/getactorbonename.html new file mode 100644 index 0000000..3b9c7e7 --- /dev/null +++ b/doc/doc_files/getactorbonename.html @@ -0,0 +1,21 @@ + + + + + ++ Returns an actor's bone name +
++ NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getactorboneposition.html b/doc/doc_files/getactorboneposition.html new file mode 100644 index 0000000..fbcac35 --- /dev/null +++ b/doc/doc_files/getactorboneposition.html @@ -0,0 +1,21 @@ + + + + + ++ Gets an actor's bone position +
++ NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getactorbonerelativetranform.html b/doc/doc_files/getactorbonerelativetranform.html new file mode 100644 index 0000000..a0be9a2 --- /dev/null +++ b/doc/doc_files/getactorbonerelativetranform.html @@ -0,0 +1,21 @@ + + + + + ++ Stores the local transform of a bone in t_matrix +
++ NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getactorbonerotation.html b/doc/doc_files/getactorbonerotation.html new file mode 100644 index 0000000..4880110 --- /dev/null +++ b/doc/doc_files/getactorbonerotation.html @@ -0,0 +1,21 @@ + + + + + ++ Gets an actor's bone rotation +
++ NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getactorbonescale.html b/doc/doc_files/getactorbonescale.html new file mode 100644 index 0000000..cc42a80 --- /dev/null +++ b/doc/doc_files/getactorbonescale.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the scale transform for an actor's bone +
++ NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getactortype.html b/doc/doc_files/getactortype.html new file mode 100644 index 0000000..10779b1 --- /dev/null +++ b/doc/doc_files/getactortype.html @@ -0,0 +1,62 @@ + + + + + ++ Returns an actor's type +
++ Actor Types +
++ NOTE: Cube and Sphere actors both return ACTOR_TYPE_PRIMITIVE +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getbillboardsize.html b/doc/doc_files/getbillboardsize.html new file mode 100644 index 0000000..6c70f75 --- /dev/null +++ b/doc/doc_files/getbillboardsize.html @@ -0,0 +1,18 @@ + + + + + ++ Gets the width and height of a billboard. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getcompositeaabb.html b/doc/doc_files/getcompositeaabb.html new file mode 100644 index 0000000..dbde9d7 --- /dev/null +++ b/doc/doc_files/getcompositeaabb.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the bounding box of a composite actor +
++ t_matrix will store the transform for the bounding box +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getcompositechild.html b/doc/doc_files/getcompositechild.html new file mode 100644 index 0000000..e2d288c --- /dev/null +++ b/doc/doc_files/getcompositechild.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the actor stored as the child actor at a given index in a composite actor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getcompositechildcount.html b/doc/doc_files/getcompositechildcount.html new file mode 100644 index 0000000..afaef77 --- /dev/null +++ b/doc/doc_files/getcompositechildcount.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the number of child actors in a composite actor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getcompositechildindex.html b/doc/doc_files/getcompositechildindex.html new file mode 100644 index 0000000..4647744 --- /dev/null +++ b/doc/doc_files/getcompositechildindex.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the index an actor is stored at in a composite actor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getcompositechildtransform.html b/doc/doc_files/getcompositechildtransform.html new file mode 100644 index 0000000..0102850 --- /dev/null +++ b/doc/doc_files/getcompositechildtransform.html @@ -0,0 +1,18 @@ + + + + + ++ Stores the transform from composite actor to the child index shape in t_matrix +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getcompositeupdaterevision.html b/doc/doc_files/getcompositeupdaterevision.html new file mode 100644 index 0000000..2b40c22 --- /dev/null +++ b/doc/doc_files/getcompositeupdaterevision.html @@ -0,0 +1,18 @@ + + + + + ++ Returns a counter that increments when the composite actor shape is modifed +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/gethorizontalangle.html b/doc/doc_files/gethorizontalangle.html new file mode 100644 index 0000000..7c22a2f --- /dev/null +++ b/doc/doc_files/gethorizontalangle.html @@ -0,0 +1,18 @@ + + + + + ++ Get the rotation vector that would make a (0,0,1) direction vector point in the same direction as the given direction vector +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getlineangle.html b/doc/doc_files/getlineangle.html new file mode 100644 index 0000000..27bad07 --- /dev/null +++ b/doc/doc_files/getlineangle.html @@ -0,0 +1,18 @@ + + + + + ++ Gets an angle between 2 points +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getmeshbuffer.html b/doc/doc_files/getmeshbuffer.html new file mode 100644 index 0000000..68e619a --- /dev/null +++ b/doc/doc_files/getmeshbuffer.html @@ -0,0 +1,21 @@ + + + + + ++ Gets the data in a mesh buffer. +
++ Returns TRUE if successful and FALSE if not. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getmeshbuffercount.html b/doc/doc_files/getmeshbuffercount.html new file mode 100644 index 0000000..fc5c260 --- /dev/null +++ b/doc/doc_files/getmeshbuffercount.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the number of mesh buffers in a mesh. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getmeshbufferindexcount.html b/doc/doc_files/getmeshbufferindexcount.html new file mode 100644 index 0000000..1af6c5d --- /dev/null +++ b/doc/doc_files/getmeshbufferindexcount.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the number of indices in a mesh buffer +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getmeshbuffervertexcount.html b/doc/doc_files/getmeshbuffervertexcount.html new file mode 100644 index 0000000..6415bea --- /dev/null +++ b/doc/doc_files/getmeshbuffervertexcount.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the number of vertices in a mesh buffer. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getmeshpolygoncount.html b/doc/doc_files/getmeshpolygoncount.html new file mode 100644 index 0000000..bf6741a --- /dev/null +++ b/doc/doc_files/getmeshpolygoncount.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the number of polygons in a mesh +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getphysics3d.html b/doc/doc_files/getphysics3d.html new file mode 100644 index 0000000..62d087c --- /dev/null +++ b/doc/doc_files/getphysics3d.html @@ -0,0 +1,24 @@ + + + + + ++ Return if the physics engine is enabled +
++ NOTE: While the physics engine is disabled, actor collisions won't be able to be checked. +
+Related: + SetPhysics3D +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getposteffectproperty.html b/doc/doc_files/getposteffectproperty.html new file mode 100644 index 0000000..6737d7a --- /dev/null +++ b/doc/doc_files/getposteffectproperty.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the value of the property on the current canvas post effect. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getposteffecttype.html b/doc/doc_files/getposteffecttype.html new file mode 100644 index 0000000..1e51454 --- /dev/null +++ b/doc/doc_files/getposteffecttype.html @@ -0,0 +1,44 @@ + + + + + ++ Returns the type of post effect set on the given canvas. +
++ Possible Effect Types +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getprojectoreffectactor.html b/doc/doc_files/getprojectoreffectactor.html new file mode 100644 index 0000000..f823da1 --- /dev/null +++ b/doc/doc_files/getprojectoreffectactor.html @@ -0,0 +1,24 @@ + + + + + ++ Returns the effect actor at tgt_index in a projector +
++ Refer to the included Projector Demo for an example +
+Related: + AddProjectorEffectActor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getprojectoreffectactorcount.html b/doc/doc_files/getprojectoreffectactorcount.html new file mode 100644 index 0000000..c8490bb --- /dev/null +++ b/doc/doc_files/getprojectoreffectactorcount.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the number of effect actors on a projector +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getprojectortexture.html b/doc/doc_files/getprojectortexture.html new file mode 100644 index 0000000..702c794 --- /dev/null +++ b/doc/doc_files/getprojectortexture.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the image currently being projected by the projector +
+Related: + SetProjectorTexture +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getrotationtotarget.html b/doc/doc_files/getrotationtotarget.html new file mode 100644 index 0000000..cba75fd --- /dev/null +++ b/doc/doc_files/getrotationtotarget.html @@ -0,0 +1,18 @@ + + + + + ++ Gets a rotation vector to a target from an origin point +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getspriteanimationsource.html b/doc/doc_files/getspriteanimationsource.html new file mode 100644 index 0000000..658a666 --- /dev/null +++ b/doc/doc_files/getspriteanimationsource.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the image associated with the given sprite animation. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getspritechildindex.html b/doc/doc_files/getspritechildindex.html new file mode 100644 index 0000000..093dc5f --- /dev/null +++ b/doc/doc_files/getspritechildindex.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the index a child_sprite is stored at in a parent sprite +
++ Returns -1 if child_sprite is not a child of sprite +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getspriteworldcenter.html b/doc/doc_files/getspriteworldcenter.html new file mode 100644 index 0000000..2d63cfd --- /dev/null +++ b/doc/doc_files/getspriteworldcenter.html @@ -0,0 +1,18 @@ + + + + + ++ Gets the center of a sprite's shape as world coordinates. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getvehicleaxis.html b/doc/doc_files/getvehicleaxis.html new file mode 100644 index 0000000..4767e5b --- /dev/null +++ b/doc/doc_files/getvehicleaxis.html @@ -0,0 +1,29 @@ + + + + + ++ Gets the axis used to define a vehicles orientation. +
+| Direction | Axis | Meaning |
|---|---|---|
| X | Right Axis | Wheel axle direction |
| Y | Up Axis | Suspension direction |
| Z | Forward Axis | Driving direction |
Related: + SetWheelAxel + SetSuspensionLength + SetWheelDirection +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getvehiclechassisworldtransform.html b/doc/doc_files/getvehiclechassisworldtransform.html new file mode 100644 index 0000000..da4c808 --- /dev/null +++ b/doc/doc_files/getvehiclechassisworldtransform.html @@ -0,0 +1,18 @@ + + + + + ++ Stores the world transform of the chassis actor in a vehicle +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getvehiclecurrentspeed.html b/doc/doc_files/getvehiclecurrentspeed.html new file mode 100644 index 0000000..55eaacf --- /dev/null +++ b/doc/doc_files/getvehiclecurrentspeed.html @@ -0,0 +1,18 @@ + + + + + ++ Returns the current speed set on the vehicle +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getvehicleforwardvector.html b/doc/doc_files/getvehicleforwardvector.html new file mode 100644 index 0000000..9d90487 --- /dev/null +++ b/doc/doc_files/getvehicleforwardvector.html @@ -0,0 +1,18 @@ + + + + + ++ Gets the forward vector of a vehicle +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getvehiclepitchcontrol.html b/doc/doc_files/getvehiclepitchcontrol.html new file mode 100644 index 0000000..28e9658 --- /dev/null +++ b/doc/doc_files/getvehiclepitchcontrol.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the pitch control for a vehicle +
+Related: + SetVehiclePitchControl +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelactoroffsettransform.html b/doc/doc_files/getwheelactoroffsettransform.html new file mode 100644 index 0000000..af6f253 --- /dev/null +++ b/doc/doc_files/getwheelactoroffsettransform.html @@ -0,0 +1,27 @@ + + + + + ++ Stores the local offset transform for the wheel actor in t_matrix. +
++ This is mainly for when the actors local transform does not line up with the axis for the vehicle. +
++ Refer to the Vehicle demo to see an example of this. +
+Related: + SetWheelActorOffsetTransform +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelaxel.html b/doc/doc_files/getwheelaxel.html new file mode 100644 index 0000000..9a787d6 --- /dev/null +++ b/doc/doc_files/getwheelaxel.html @@ -0,0 +1,21 @@ + + + + + ++ Get the axel direction of a wheel on a vehicle +
+Related: + SetWheelAxel +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelbrake.html b/doc/doc_files/getwheelbrake.html new file mode 100644 index 0000000..de6c81c --- /dev/null +++ b/doc/doc_files/getwheelbrake.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the brake value of a wheel on a vehicle +
+Related: + SetWheelBrake +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelconnectionpoint.html b/doc/doc_files/getwheelconnectionpoint.html new file mode 100644 index 0000000..4d2f545 --- /dev/null +++ b/doc/doc_files/getwheelconnectionpoint.html @@ -0,0 +1,21 @@ + + + + + ++ Gets the point in local space that a wheel is connected to a vehicle at +
+Related: + SetWheelConnectionPoint +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelcount.html b/doc/doc_files/getwheelcount.html new file mode 100644 index 0000000..d29cd7f --- /dev/null +++ b/doc/doc_files/getwheelcount.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the number of wheels on a vehicle +
+Related: + AddVehicleWheel +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheeldampingcompression.html b/doc/doc_files/getwheeldampingcompression.html new file mode 100644 index 0000000..a4652c6 --- /dev/null +++ b/doc/doc_files/getwheeldampingcompression.html @@ -0,0 +1,22 @@ + + + + + ++ Returns the damping compression of a wheel +
+Related: + GetWheelDampingRelaxation + SetWheelDampingCompression +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheeldampingrelaxation.html b/doc/doc_files/getwheeldampingrelaxation.html new file mode 100644 index 0000000..1c3489f --- /dev/null +++ b/doc/doc_files/getwheeldampingrelaxation.html @@ -0,0 +1,22 @@ + + + + + ++ Returns the damping relaxation of a wheel +
+Related: + GetWheelDampingCompression + SetWheelDampingRelaxation +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheeldirection.html b/doc/doc_files/getwheeldirection.html new file mode 100644 index 0000000..87218a2 --- /dev/null +++ b/doc/doc_files/getwheeldirection.html @@ -0,0 +1,18 @@ + + + + + ++ Gets the direction of a wheel on a vehicle +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelengineforce.html b/doc/doc_files/getwheelengineforce.html new file mode 100644 index 0000000..1ece551 --- /dev/null +++ b/doc/doc_files/getwheelengineforce.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the engine force currently applied to a wheel +
+Related: + SetWheelEngineForce +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelfrictionslip.html b/doc/doc_files/getwheelfrictionslip.html new file mode 100644 index 0000000..aa0f0df --- /dev/null +++ b/doc/doc_files/getwheelfrictionslip.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the friction slip of a wheel +
+Related: + SetWheelFrictionSlip +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelinversecontactsuspension.html b/doc/doc_files/getwheelinversecontactsuspension.html new file mode 100644 index 0000000..6daa3b0 --- /dev/null +++ b/doc/doc_files/getwheelinversecontactsuspension.html @@ -0,0 +1,27 @@ + + + + + ++ Returns the clipped inverse contact dot suspension. +
++ This value is a stability factor used to adjust suspension force when the ground contact surface is tilted. +
++ It prevents suspension forces from exploding when the wheel contacts steep surfaces. +
+Related: + SetWheelInverseContactSuspension +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelmaxsuspensiontravel.html b/doc/doc_files/getwheelmaxsuspensiontravel.html new file mode 100644 index 0000000..51e1082 --- /dev/null +++ b/doc/doc_files/getwheelmaxsuspensiontravel.html @@ -0,0 +1,24 @@ + + + + + ++ Returns the max suspension travel distance. +
++ This value is the maximum distance the suspension is allowed to extend or compress from its rest length set with SetSuspensionLength(). +
+Related: + SetWheelMaxSuspension +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelradius.html b/doc/doc_files/getwheelradius.html new file mode 100644 index 0000000..f7a2932 --- /dev/null +++ b/doc/doc_files/getwheelradius.html @@ -0,0 +1,21 @@ + + + + + ++ You will never guess what this returns +
+Related: + SetWheelRadius +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelrollinfluence.html b/doc/doc_files/getwheelrollinfluence.html new file mode 100644 index 0000000..1a41e8e --- /dev/null +++ b/doc/doc_files/getwheelrollinfluence.html @@ -0,0 +1,27 @@ + + + + + ++ Returns the roll_influence for a wheel. +
++ Roll influence controls how much a wheel’s suspension force contributes to the vehicle’s body roll (sideways tipping). +
++ It’s essentially a stability scaling factor. +
+Related: + SetWheelRollInfluence +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelrotation.html b/doc/doc_files/getwheelrotation.html new file mode 100644 index 0000000..6a431d9 --- /dev/null +++ b/doc/doc_files/getwheelrotation.html @@ -0,0 +1,21 @@ + + + + + ++ Returns a wheel's spin rotation. +
+Related: + SetWheelRotation +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelrotationdelta.html b/doc/doc_files/getwheelrotationdelta.html new file mode 100644 index 0000000..fc348c9 --- /dev/null +++ b/doc/doc_files/getwheelrotationdelta.html @@ -0,0 +1,21 @@ + + + + + ++ Returns how much the wheels spin angle changed since the last frame. +
+Related: + SetWheelRotationDelta +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelsteeringvalue.html b/doc/doc_files/getwheelsteeringvalue.html new file mode 100644 index 0000000..bf2901c --- /dev/null +++ b/doc/doc_files/getwheelsteeringvalue.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the steering value for a wheel +
+Related: + SetWheelSteeringValue +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelsuspensionlength.html b/doc/doc_files/getwheelsuspensionlength.html new file mode 100644 index 0000000..7e6cdc9 --- /dev/null +++ b/doc/doc_files/getwheelsuspensionlength.html @@ -0,0 +1,21 @@ + + + + + ++ Returns the suspsension rest length of a wheel +
+Related: + SetWheelSuspensionLength +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelsuspensionstiffness.html b/doc/doc_files/getwheelsuspensionstiffness.html new file mode 100644 index 0000000..9f2ac2a --- /dev/null +++ b/doc/doc_files/getwheelsuspensionstiffness.html @@ -0,0 +1,29 @@ + + + + + ++ Returns the suspension stiffness of a wheel. +
+Related: + SetWheelSuspensionStiffness +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelsuspensionvelocity.html b/doc/doc_files/getwheelsuspensionvelocity.html new file mode 100644 index 0000000..129e2bd --- /dev/null +++ b/doc/doc_files/getwheelsuspensionvelocity.html @@ -0,0 +1,24 @@ + + + + + ++ Returns the suspension velocity. +
++ This value is the speed that the suspension compresses or extends at. +
+Related: + SetWheelSuspensionVelocity +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/getwheelworldtransform.html b/doc/doc_files/getwheelworldtransform.html new file mode 100644 index 0000000..1f27e96 --- /dev/null +++ b/doc/doc_files/getwheelworldtransform.html @@ -0,0 +1,24 @@ + + + + + ++ Returns the world transform of a wheel on a vehicle. +
++ NOTE: This will not be the world tranform of the actor if an offset transform has been set. In that case you will need to multiply the offset by the world transform. +
+Related: + SetWheelWorldTransform +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/graphics2.html b/doc/doc_files/graphics2.html new file mode 100644 index 0000000..0dccc58 --- /dev/null +++ b/doc/doc_files/graphics2.html @@ -0,0 +1,170 @@ + + + + + ++ The last section was a basic overview of graphics so in this section, I am going to go more indepth on sprites. In RCBasic, sprites are 2D objects with animation and physics properties. Sprite physics and animations are updated each time Update() is called. +
++ To create a sprite, you must have a sprite canvas as your active canvas. Here is a quick explanation of how to open a new sprite canvas. +
+
+ pos_x = 0
+ pos_y = 0
+ viewport_width = 640
+ viewport_height = 480
+
+ sprite_canvas = OpenCanvasSpriteLayer(pos_x, pos_y, viewport_width, viewport_height)
+
+ Sprite canvases are opened with OpenCanvasSpriteLayer(). You only need to pass the position in the window where the viewport starts at and the size of the viewport. Sprite canvases don't have a fixed size since it only renders the part of the canvas that is visible. +
++ Once you have opened a sprite canvas, use the Canvas() function to set the sprite canvas as active. +
+
+ Canvas(sprite_canvas)
+
+ Now you are ready to create a sprite. To create a sprite, normally you would need a sprite sheet. The sprite sheet is a image file that contains all the animations for your sprite. +
+
+ spriteSheet = LoadImage("graizor.png")
+
+ frame_width = 32
+ frame_height = 32
+
+ mySprite = CreateSprite(spriteSheet, frame_width, frame_height)
+
+ Sprites are created with the CreateSprite() function. Sprites have a default animation that is 1 frame in length and set as the first frame in the sprite sheet. The frames in a sprite sheet start at 0 and increase going from left to right and continue incrementing down each row. So if each row as 4 frames then the first row would have frames 0 to 3 and the second row would start at 4 and continue until the end of the last row. +
+
+ To animate our sprite, we have to create an animation for it. You can create an animation with the CreateSpriteAnimation() function. +
+
+ walk_left_animation = CreateSpriteAnimation(mySprite, 4, 12)
+ SetSpriteAnimationFrame(mySprite, walk_left_animation, 0, 28)
+ SetSpriteAnimationFrame(mySprite, walk_left_animation, 1, 29)
+ SetSpriteAnimationFrame(mySprite, walk_left_animation, 2, 30)
+ SetSpriteAnimationFrame(mySprite, walk_left_animation, 3, 31)
+
+ CreateSpriteAnimation() takes 3 parameters +
++ SetSpriteAnimationFrame() takes 4 parameters +
++ Now to play the animation, we just set the animation on the sprite. +
+
+ SetSpriteAnimation(mySprite, walk_left_animation, -1)
+
+ SetSpriteAnimation() takes the sprite, the animation, and the last parameter is the number of times to loop the animation. Setting it to a value less than 0 will cause it to loop infinitely. +
++ Thats the basics of sprite animation. Next lets go over sprite physics. By default, a sprite is non-solid which means it won't collide with anything. To change our sprite to solid, we just call the SetSpriteSolid() function. +
+
+ SetSpriteSolid(mySprite, TRUE)
+
+ To have the sprite fall, we need to set gravity for our sprite canvas. We do that with SetGravity2D(). +
+
+ SetGravity2D(0, 30)
+
+ SetGravity2D() takes an x and y value for the direction gravity pulls in. We just want gravity pulling down on our sprite. This would have our sprite falling forever since there is no ground for the sprite to collide with. So we need to create another sprite for the ground. +
+
+ ground = CreateSprite(-1, 640, 100)
+ SetSpriteSolid(ground, TRUE)
+ SetSpritePosition(ground, 0, 380)
+ SetSpriteType(ground, SPRITE_TYPE_STATIC)
+
+ There is a few things to go over with how the ground was created. First, we use -1 instead of an image for the ground. If you use a value less than 0 when creating a sprite, it will just create a physics object without any animation. This works well for a ground since we can draw an image on a paint canvas or draw a tile map. +
++ On the next 2 lines we are setting the ground as solid and setting the grounds position to the bottom of our screen. +
++ The last line is setting the ground sprite as static. This sets the ground as an unmovable object. +
++ Since the ground does not have an image associated with it, we can just open a paint canvas over the sprite layer and draw a rectangle covering the area where our ground physics object is. +
+
+ paint_canvas = OpenCanvas(640, 480, 0, 0, 640, 480, 1)
+ SetCanvasZ(paint_canvas, 1)
+
+ We use OpenCanvas() from the last section to open a paint canvas here. Setting the last parameter in OpenCanvas() to 1 will make the canvas background clear so we can see the sprite canvas behind it. +
++ SetCanvasZ() changes the render order for the canvas. Canvases with a higher Z order are drawn on top of canvases with lower Z order. Now we can switch to the paint canvas to draw a rectangle using the functions from the last section. +
+
+ SetColor( RGB(200, 0, 0) ) 'Sets the drawing color to red
+ RectFill(0, 380, 640, 100) 'Draws a filled rectangle with the current draw color
+
+ We are drawing our rectangle at the location where we positioned our ground sprite above with the size that we made our ground sprite object. That will make our sprite ground visible for us to land on. +
++ The last thing we will do is make our sprite move when we press a key. +
+
+ If Key(K_RIGHT) Then
+ SetSpriteLinearVelocity(mySprite, 30, 0)
+ End If
+
+ Key() returns true if the key code parameter is pressed. You can see a list of all the key codes in the Key Codes section in the Appendix. +
++ We use SetSpriteLinearVelocity() to move the sprite instead of SetSpritePosition() because we don't want to directly move a sprite that we want physics to be applied to. There are a few functions for applying forces to a sprite that you can find under the Sprite Physics section in the manual. +
++ And that is it for our simple overview of sprites. To see a full working example of the concepts covered here, try out the Sprite Test example in the examples folder. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/graphics3.html b/doc/doc_files/graphics3.html new file mode 100644 index 0000000..502db35 --- /dev/null +++ b/doc/doc_files/graphics3.html @@ -0,0 +1,180 @@ + + + + + ++ This last section will cover how 3D graphics work in RCBasic. We can render the scene with a 3D canvas which is opened with OpenCanvas3D() +
+
+ viewport_width = 640
+ viewport_height = 480
+ scene_canvas = OpenCanvas3D(0, 0, viewport_width, viewport_height, 1)
+
+ OpenCanvas3D takes some of the same parameters as OpenCanvas. It will open a canvas to view the 3D scene. You can open multiple 3D canvases to view the 3D scene from different camera angles but there is only one 3D scene. +
++ Next, lets go over actors. Actors are objects in our 3D scene and similiar to what sprites are on a sprite canvas. There are different types of actors that we can create and each one serves a different purpose. For now lets just create an animated actor. +
+
+ hero_mesh = LoadMesh("char.ms3d") ' Load a 3D model from a file
+ hero = CreateAnimatedActor(hero_mesh) ' Create an animated object in our scene from the 3D model
+
+ We use LoadMesh() to load a 3D model into our program. If we want to make multiple actors in our scene from this 3D model, we only need to load the model once. +
++ After we load the model, we use CreateAnimatedActor() to create an object in our scene using the 3D model. Animated actors function like 3D version of sprites since they have animation and physics. Adding animation to our animated actor is a similiar process to adding animation to our sprite from the last section. +
+
+ RUN_ANIMATION = CreateActorAnimation(hero, 13, 36, 30)
+
+ CreateActorAnimation() takes 4 parameters. +
++ Now that we have an animation, we can set the actor's animation in the same way we set the sprite's animation in the last section. +
+
+ SetActorAnimation(hero, RUN_ANIMATION, -1)
+
+ SetActorAnimation() works the same way that SetSpriteAnimation() does. It takes the actor, the animation, and number of animation loops. We can set it to a value less than 0 to loop infinitely just like we did with our sprite in the last section. +
++ Currently, the actor will not have any color. We need to add a texture to the actor. We will also disable lighting for the actor for now so that it just renders with the texture applied. +
+
+ hero_material = GetActorMaterial(hero, 0)
+
+ SetMaterialLighting(hero_material, FALSE)
+
+ hero_texture = LoadImage("hero.png")
+ SetMaterialTexture(hero_material, 0, hero_texture)
+
+ First, we get a reference to our actors material with GetActorMaterial(). We use this reference to set properties for the actor's material. The material determines how the actor is rendered. +
++ Next, we disable lighting for the material. This means that lighting will not determine how light or dark the texture will be rendered at. +
++ Finally, we load an image and set it to the first texture slot on the material with SetMaterialTexture(). +
++ This now puts our actor in our scene with our texture applied. But just like in the sprite section, our actor needs to have physics applied to it. So lets make the actor solid and set our scene gravity. +
+
+ SetActorSolid(cube, TRUE)
+ SetGravity3D(0, -10, 0)
+
+ SetActorSolid() functions just like SetSpriteSolid() does. SetGravity3D() is like SetGravity2D() but it adds a 3rd dimension to it. +
++ Now we need a ground plane. Lets create a plane mesh and then create an octree actor from it to serve as our ground. Octree actors are actors with meshes that have optimizations for large scenes. +
+
+ plane_mesh = CreatePlaneMesh(1000, 1000, 100, 100, 100, 100)
+ plane = CreateOctreeActor(plane_mesh)
+
+ CreatePlaneMesh() is used to create a plane mesh rather than use LoadMesh() to load it from an external file like we did earlier. +
++ CreateOctreeActor() will create an octree actor rather than an animated actor. +
++ Next we will set a solid color material for our plane rather than load another texture. +
+
+ plane_material = CreateMaterial()
+ SetMaterialType(plane_material, FX_MATERIAL_TYPE_PLASTIC)
+ SetActorMaterial(plane, 0, plane_material)
+
+ We are using an FX material here which is a special type of material with separate properties from a normal material. This time we had to use CreateMaterial() to make a new material. To make FX materials, you must create a new material since you can not set any of the FX material types on a material attached to an actor. +
++ Then we just set our material type with SetMaterialType() and set the material on the actor with SetActorMaterial(). +
++ Now lets set our physics properties for our plane. +
+
+ SetActorSolid(plane, TRUE)
+ SetActorShape(plane, ACTOR_SHAPE_TRIMESH, 0)
+
+ Yet again, we are using SetActorSolid() to set our actor solid. We use SetActorShape() to change the shape of the plane to ACTOR_SHAPE_TRIMESH. By default, actors shapes are ACTOR_SHAPE_BOX. Boxes are fine for our actor's hit box but we want a shape with more geometry for our ground usually. +
++ Just like what we did with our sprites in the last lesson, lets have the actor move when a key is pressed. +
+
+ If Key(K_RIGHT) Then
+ SetActorLinearVelocityLocal(hero, 0, 0, 20)
+ End If
+
+ This looks very similiar to our code for moving the sprite in the last lesson. SetActorLinearVelocityLocal() has a little bit longer name. It has a companion function called SetActorLinearVelocityWorld() which applies a transform based on world instead of local space. +
++ Before moving on, I want to quickly explain the difference between local transforms and world transforms. +
++ Before ending this lesson, lets do a quick overview of how to set the camera. Each 3D canvas has its own camera. To set the camera for a 3D canvas you must make sure you set the 3D canvas active with Canvas(). +
+
+ Canvas(scene_canvas)
+
+ SetCameraPosition(0, 30, -100) 'Set the camera position
+ SetCameraRotation(20, 0, 0) 'Set the camera rotation
+
+ SetCameraPosition() and SetCameraRotation() do exactly what you think they do. There are also other functions to set camera FOV(field of view), aspect ratio, etc. Look in the camera section for more info. +
++ Refer to the Intro to 3D demo for the complete code for this lesson. +
++ RCBasic has several functions for graphics, physics, etc., so if you can't find it in the manual then feel free to ask a question on the forum. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/images/banner.png b/doc/doc_files/images/banner.png new file mode 100755 index 0000000..c19dea3 Binary files /dev/null and b/doc/doc_files/images/banner.png differ diff --git a/doc/doc_files/images/sprite_frames.aseprite b/doc/doc_files/images/sprite_frames.aseprite new file mode 100644 index 0000000..845abb0 Binary files /dev/null and b/doc/doc_files/images/sprite_frames.aseprite differ diff --git a/doc/doc_files/images/sprite_frames.png b/doc/doc_files/images/sprite_frames.png new file mode 100644 index 0000000..a7cc52e Binary files /dev/null and b/doc/doc_files/images/sprite_frames.png differ diff --git a/doc/doc_files/interpolatevector.html b/doc/doc_files/interpolatevector.html new file mode 100644 index 0000000..ef342a7 --- /dev/null +++ b/doc/doc_files/interpolatevector.html @@ -0,0 +1,18 @@ + + + + + ++ Gets an interpolated vector a given distance along a line starting at (x1, y1, z1) and ending at (x2, y2, z2) +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/interpolatevectorq.html b/doc/doc_files/interpolatevectorq.html new file mode 100644 index 0000000..a389a78 --- /dev/null +++ b/doc/doc_files/interpolatevectorq.html @@ -0,0 +1,18 @@ + + + + + ++ Gets a quadratic interpolated vector based on a distance between 3 vectors +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/makeplanartexturemap.html b/doc/doc_files/makeplanartexturemap.html new file mode 100644 index 0000000..a2a3693 --- /dev/null +++ b/doc/doc_files/makeplanartexturemap.html @@ -0,0 +1,21 @@ + + + + + ++ Makes a planar texture map for the mesh. +
++ Resolution is a ratio of the world space to texture space NOTE: Value should be between 0 and 1, a recommended value to start with is 0.001 +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/matrixexists.html b/doc/doc_files/matrixexists.html new file mode 100644 index 0000000..b7d848d --- /dev/null +++ b/doc/doc_files/matrixexists.html @@ -0,0 +1,18 @@ + + + + + ++ Returns TRUE if a matrix exists and FALSE if not. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/normalizevector.html b/doc/doc_files/normalizevector.html new file mode 100644 index 0000000..b5b9d74 --- /dev/null +++ b/doc/doc_files/normalizevector.html @@ -0,0 +1,18 @@ + + + + + ++ Returns a normalized vector from (x,y,z) +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/pipeline_begin.html b/doc/doc_files/pipeline_begin.html new file mode 100644 index 0000000..c4f35d0 --- /dev/null +++ b/doc/doc_files/pipeline_begin.html @@ -0,0 +1,18 @@ + + + + + ++ Begins a custom rendering process. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/pipeline_end.html b/doc/doc_files/pipeline_end.html new file mode 100644 index 0000000..5352e22 --- /dev/null +++ b/doc/doc_files/pipeline_end.html @@ -0,0 +1,18 @@ + + + + + ++ Ends a custom rendering process. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/pipeline_render.html b/doc/doc_files/pipeline_render.html new file mode 100644 index 0000000..c39c0fa --- /dev/null +++ b/doc/doc_files/pipeline_render.html @@ -0,0 +1,21 @@ + + + + + ++ Render the active canvas. +
++ NOTE: Must be used between Pipeline_Begin() and Pipeline_End(). +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/posteffectisactive.html b/doc/doc_files/posteffectisactive.html new file mode 100644 index 0000000..79700ed --- /dev/null +++ b/doc/doc_files/posteffectisactive.html @@ -0,0 +1,21 @@ + + + + + ++ Returns TRUE if an effect is active on the canvas and FALSE if not. +
+Related: + SetPostEffectActive +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/recalculatecompositeaabb.html b/doc/doc_files/recalculatecompositeaabb.html new file mode 100644 index 0000000..3bbf7ca --- /dev/null +++ b/doc/doc_files/recalculatecompositeaabb.html @@ -0,0 +1,18 @@ + + + + + ++ Recalculates the bounding box for a composite actor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/recalculatemeshnormals.html b/doc/doc_files/recalculatemeshnormals.html new file mode 100644 index 0000000..502957e --- /dev/null +++ b/doc/doc_files/recalculatemeshnormals.html @@ -0,0 +1,18 @@ + + + + + ++ Calculates the facing direction of the normals in a mesh +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/removecompositechild.html b/doc/doc_files/removecompositechild.html new file mode 100644 index 0000000..c485688 --- /dev/null +++ b/doc/doc_files/removecompositechild.html @@ -0,0 +1,24 @@ + + + + + ++ Removes the actor stored as a child at the given index in a composite actor +
++ NOTE: This will change the index of all the remaining child actors +
+Related: + AddCompositeChild +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/removeprojectoreffectactor.html b/doc/doc_files/removeprojectoreffectactor.html new file mode 100644 index 0000000..b79ed31 --- /dev/null +++ b/doc/doc_files/removeprojectoreffectactor.html @@ -0,0 +1,27 @@ + + + + + ++ Removes an effect actor from a projector. +
++ NOTE: Removing an effect actor will change the order of other effect actors so you will need to get the new index for other effect actors. +
++ Refer to the included Projector Demo for an example +
+Related: + AddProjectorEffectActor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/removespritechild.html b/doc/doc_files/removespritechild.html new file mode 100644 index 0000000..a92add5 --- /dev/null +++ b/doc/doc_files/removespritechild.html @@ -0,0 +1,21 @@ + + + + + ++ Removes the child at the given index from the parent sprite +
+Related: + AddSpriteChild +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/resetvehiclesuspension.html b/doc/doc_files/resetvehiclesuspension.html new file mode 100644 index 0000000..e9fffe7 --- /dev/null +++ b/doc/doc_files/resetvehiclesuspension.html @@ -0,0 +1,18 @@ + + + + + ++ Sets the suspension of a vehicle back to its base length. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/savebmp.html b/doc/doc_files/savebmp.html new file mode 100644 index 0000000..6fb2e4a --- /dev/null +++ b/doc/doc_files/savebmp.html @@ -0,0 +1,46 @@ + + + + + ++ Save an image to a *.bmp file +
+
+ title$ = "Sprite Test"
+ w = 640
+ h = 480
+ fullscreen = FALSE
+ vsync = FALSE
+
+ OpenWindow( title$, w, h, fullscreen, vsync )
+
+ my_canvas = OpenCanvas(w, h, 0, 0, w, h, 1)
+
+ Canvas(my_canvas)
+
+ SetColor(RGB(255,0, 0))
+ CircleFill(50, 50, 25)
+
+ SetColor(RGB(0, 255, 0))
+ CircleFill(590, 50, 25)
+
+ SetColor(RGB(0, 0, 255))
+ CircleFill(590, 430, 25)
+
+ img = CanvasClip(0, 0, 640, 480)
+ SaveBMP(img, "test.bmp")
+
+ Update()
+ WaitKey()
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/setactorimpactmesh.html b/doc/doc_files/setactorimpactmesh.html new file mode 100644 index 0000000..fc1c94d --- /dev/null +++ b/doc/doc_files/setactorimpactmesh.html @@ -0,0 +1,21 @@ + + + + + ++ Sets the collision mesh for an actor with a shape type of ACTOR_SHAPE_IMPACT_MESH +
+Related: + SetActorShape +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setactorshapeex.html b/doc/doc_files/setactorshapeex.html new file mode 100644 index 0000000..b05ffd6 --- /dev/null +++ b/doc/doc_files/setactorshapeex.html @@ -0,0 +1,21 @@ + + + + + ++ Sets actor shape and radius for capsule, cone, and sphere shapes +
+Related: + SetActorShape +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setbillboardsize.html b/doc/doc_files/setbillboardsize.html new file mode 100644 index 0000000..81db3fa --- /dev/null +++ b/doc/doc_files/setbillboardsize.html @@ -0,0 +1,18 @@ + + + + + ++ Sets the size of a billboard. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setmeshbuffer.html b/doc/doc_files/setmeshbuffer.html new file mode 100644 index 0000000..73fee20 --- /dev/null +++ b/doc/doc_files/setmeshbuffer.html @@ -0,0 +1,21 @@ + + + + + ++ Sets the contents of a mesh buffer. Buffer_num must already exists in mesh. +
++ Returns TRUE if successful and FALSE if not +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setphysics3d.html b/doc/doc_files/setphysics3d.html new file mode 100644 index 0000000..dc363fb --- /dev/null +++ b/doc/doc_files/setphysics3d.html @@ -0,0 +1,24 @@ + + + + + ++ Enables or disables the physics engine. +
++ NOTE: While the physics engine is disabled, actor collisions won't be able to be checked. +
+Related: + GetPhysics3D +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setposteffect.html b/doc/doc_files/setposteffect.html new file mode 100644 index 0000000..dd3cd1d --- /dev/null +++ b/doc/doc_files/setposteffect.html @@ -0,0 +1,103 @@ + + + + + ++ Sets a post effect on an canvas. +
++ Returns TRUE if successful and FALSE if not. +
++ NOTE: Post Effects only apply to 3D canvases. +
++ Possible Effects and there properties: +
+Related: + ClearPostEffect +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setposteffectactive.html b/doc/doc_files/setposteffectactive.html new file mode 100644 index 0000000..f614597 --- /dev/null +++ b/doc/doc_files/setposteffectactive.html @@ -0,0 +1,21 @@ + + + + + ++ Enables or Disables currently set effect +
+Related: + PostEffectIsActive +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setposteffectproperty.html b/doc/doc_files/setposteffectproperty.html new file mode 100644 index 0000000..5131773 --- /dev/null +++ b/doc/doc_files/setposteffectproperty.html @@ -0,0 +1,45 @@ + + + + + ++ Sets the value of a post effect property for a canvas. +
++ Possible Properties: +
++ Reference SetPostEffect() for which properties apply to each effect +
+Related: + GetPostEffectProperty + SetPostEffect +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setprojectortexture.html b/doc/doc_files/setprojectortexture.html new file mode 100644 index 0000000..7c0e339 --- /dev/null +++ b/doc/doc_files/setprojectortexture.html @@ -0,0 +1,21 @@ + + + + + ++ Sets the texture that is projected by a projector. +
+Related: + CreateProjectorActor +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setrendercirclepoints.html b/doc/doc_files/setrendercirclepoints.html new file mode 100644 index 0000000..a82a424 --- /dev/null +++ b/doc/doc_files/setrendercirclepoints.html @@ -0,0 +1,24 @@ + + + + + ++ Sets the number of points used to draw circles with Circle, CircleFill, Ellipse, and EllipseFill +
+Related: + Circle + CircleFill + Ellipse + EllipseFill +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setspritelayerpriority.html b/doc/doc_files/setspritelayerpriority.html new file mode 100644 index 0000000..259822b --- /dev/null +++ b/doc/doc_files/setspritelayerpriority.html @@ -0,0 +1,14 @@ + + + + + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setup.html b/doc/doc_files/setup.html index af26f53..7e66804 100644 --- a/doc/doc_files/setup.html +++ b/doc/doc_files/setup.html @@ -14,17 +14,6 @@
RCBasic also comes with a 2D level editor called Nirvana and a 3D level editor called Serenity. If you are on linux there is a start up script for each one in the main folder where RCBasic is extracted. On Windows, just go into each folder and start up the exe for the editor you want to use.
-- There is a video going over the basics of each editor here: -
-
+ Sets a vehicles pitch control. +
++ Pitch control is a tuning parameter that adds an extra torque to the chassis based on engine force to control how much the vehicle tilts forward or backward under acceleration and braking. +
+Related: + GetVehiclePitchControl +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelactoroffsettransform.html b/doc/doc_files/setwheelactoroffsettransform.html new file mode 100644 index 0000000..1d4d818 --- /dev/null +++ b/doc/doc_files/setwheelactoroffsettransform.html @@ -0,0 +1,24 @@ + + + + + ++ Sets an local offset transform for the wheel actor. This is mainly for when the actors local transform does not line up with the axis for the vehicle. +
++ Refer to the Vehicle demo to see an example of this. +
+Related: + GetWheelActorOffsetTransform +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelaxel.html b/doc/doc_files/setwheelaxel.html new file mode 100644 index 0000000..03a5271 --- /dev/null +++ b/doc/doc_files/setwheelaxel.html @@ -0,0 +1,24 @@ + + + + + ++ Sets the wheel axel direction. +
++ The axel is the axis the wheel rotates around. +
+Related: + GetWheelAxel +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelbrake.html b/doc/doc_files/setwheelbrake.html new file mode 100644 index 0000000..301fd9a --- /dev/null +++ b/doc/doc_files/setwheelbrake.html @@ -0,0 +1,21 @@ + + + + + ++ Sets the brake value for a wheel +
+Related: + GetWheelBrake +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelconnectionpoint.html b/doc/doc_files/setwheelconnectionpoint.html new file mode 100644 index 0000000..0869456 --- /dev/null +++ b/doc/doc_files/setwheelconnectionpoint.html @@ -0,0 +1,21 @@ + + + + + ++ Sets the point in local space where the wheel connects to the chassis +
+Related: + GetWheelConnectionPoint +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheeldampingcompression.html b/doc/doc_files/setwheeldampingcompression.html new file mode 100644 index 0000000..ff66bb1 --- /dev/null +++ b/doc/doc_files/setwheeldampingcompression.html @@ -0,0 +1,22 @@ + + + + + ++ Sets a wheels damping compression +
+Related: + SetWheelDampingRelaxation + GetWheelDampingCompression +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheeldampingrelaxation.html b/doc/doc_files/setwheeldampingrelaxation.html new file mode 100644 index 0000000..838240a --- /dev/null +++ b/doc/doc_files/setwheeldampingrelaxation.html @@ -0,0 +1,22 @@ + + + + + ++ Sets a wheels damping relaxation +
+Related: + GetWheelDampingRelaxation + SetWheelDampingCompression +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheeldirection.html b/doc/doc_files/setwheeldirection.html new file mode 100644 index 0000000..709eeaf --- /dev/null +++ b/doc/doc_files/setwheeldirection.html @@ -0,0 +1,24 @@ + + + + + ++ Sets a wheel's direction +
++ This direction is the direction the suspension of the wheel extends to and not the direction the wheel rolls. Basically, if the suspension is pointing straight down then the direction would be (0, -1, 0). +
+Related: + GetWheelDirection +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelfrictionslip.html b/doc/doc_files/setwheelfrictionslip.html new file mode 100644 index 0000000..1384c3b --- /dev/null +++ b/doc/doc_files/setwheelfrictionslip.html @@ -0,0 +1,32 @@ + + + + + ++ Sets the friction slip value for a wheel. +
++ This value determines how much grip a wheel has before it starts sliding +
+Related: + GetWheelFrictionSlip +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelinversecontactsuspension.html b/doc/doc_files/setwheelinversecontactsuspension.html new file mode 100644 index 0000000..cdb5491 --- /dev/null +++ b/doc/doc_files/setwheelinversecontactsuspension.html @@ -0,0 +1,27 @@ + + + + + ++ Sets the clipped inverse contact dot suspension. +
++ This value is a stability factor used to adjust suspension force when the ground contact surface is tilted. +
++ It prevents suspension forces from exploding when the wheel contacts steep surfaces. +
+Related: + GetWheelInverseContactSuspension +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelmaxsuspensiontravel.html b/doc/doc_files/setwheelmaxsuspensiontravel.html new file mode 100644 index 0000000..262be28 --- /dev/null +++ b/doc/doc_files/setwheelmaxsuspensiontravel.html @@ -0,0 +1,24 @@ + + + + + ++ Sets the max suspension travel distance. +
++ This value is the maximum distance the suspension is allowed to extend or compress from its rest length set with SetSuspensionLength(). +
+Related: + GetWheelMaxSuspension +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelradius.html b/doc/doc_files/setwheelradius.html new file mode 100644 index 0000000..4681735 --- /dev/null +++ b/doc/doc_files/setwheelradius.html @@ -0,0 +1,21 @@ + + + + + ++ Sets the radius of a wheel +
+Related: + GetWheelRadius +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelrollinfluence.html b/doc/doc_files/setwheelrollinfluence.html new file mode 100644 index 0000000..1eaf1d1 --- /dev/null +++ b/doc/doc_files/setwheelrollinfluence.html @@ -0,0 +1,27 @@ + + + + + ++ Sets the roll_influence for a wheel. +
++ Roll influence controls how much a wheel’s suspension force contributes to the vehicle’s body roll (sideways tipping). +
++ It’s essentially a stability scaling factor. +
+Related: + GetWheelRollInfluence +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelrotation.html b/doc/doc_files/setwheelrotation.html new file mode 100644 index 0000000..9a637e6 --- /dev/null +++ b/doc/doc_files/setwheelrotation.html @@ -0,0 +1,21 @@ + + + + + ++ Sets a wheel's spin rotation. +
+Related: + GetWheelRotation +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelsteeringvalue.html b/doc/doc_files/setwheelsteeringvalue.html new file mode 100644 index 0000000..c07e46a --- /dev/null +++ b/doc/doc_files/setwheelsteeringvalue.html @@ -0,0 +1,21 @@ + + + + + ++ Sets the steering value for a wheel +
+Related: + GetWheelSteeringValue +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelsuspensionlength.html b/doc/doc_files/setwheelsuspensionlength.html new file mode 100644 index 0000000..11f2533 --- /dev/null +++ b/doc/doc_files/setwheelsuspensionlength.html @@ -0,0 +1,21 @@ + + + + + ++ Sets the suspsension rest length of a wheel +
+Related: + GetWheelSuspensionLength +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelsuspensionstiffness.html b/doc/doc_files/setwheelsuspensionstiffness.html new file mode 100644 index 0000000..8e44e67 --- /dev/null +++ b/doc/doc_files/setwheelsuspensionstiffness.html @@ -0,0 +1,29 @@ + + + + + ++ Sets the suspension stiffness of a wheel. +
+Related: + GetWheelSuspensionStiffness +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/setwheelsuspensionvelocity.html b/doc/doc_files/setwheelsuspensionvelocity.html new file mode 100644 index 0000000..6efd87c --- /dev/null +++ b/doc/doc_files/setwheelsuspensionvelocity.html @@ -0,0 +1,24 @@ + + + + + ++ Sets the suspension velocity. +
++ This value is the speed that the suspension compresses or extends at. +
+Related: + GetWheelSuspensionVelocity +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/sortspritelayer.html b/doc/doc_files/sortspritelayer.html new file mode 100644 index 0000000..445cbc5 --- /dev/null +++ b/doc/doc_files/sortspritelayer.html @@ -0,0 +1,14 @@ + + + + + ++ + + \ No newline at end of file diff --git a/doc/doc_files/stack_n_exists.html b/doc/doc_files/stack_n_exists.html new file mode 100644 index 0000000..96b5f63 --- /dev/null +++ b/doc/doc_files/stack_n_exists.html @@ -0,0 +1,18 @@ + + +
+ + ++ Returns TRUE if the given number stack exists and FALSE if not. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/stack_s_exists.html b/doc/doc_files/stack_s_exists.html new file mode 100644 index 0000000..77c7db8 --- /dev/null +++ b/doc/doc_files/stack_s_exists.html @@ -0,0 +1,18 @@ + + + + + ++ Returns TRUE if the given string stack exists and FALSE if not. +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/updatecompositechildtransform.html b/doc/doc_files/updatecompositechildtransform.html new file mode 100644 index 0000000..0eeb8ca --- /dev/null +++ b/doc/doc_files/updatecompositechildtransform.html @@ -0,0 +1,18 @@ + + + + + ++ Sets a new child transform and updates dynamic AABB tree +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/vectorisbetweenpoints.html b/doc/doc_files/vectorisbetweenpoints.html new file mode 100644 index 0000000..a8a8842 --- /dev/null +++ b/doc/doc_files/vectorisbetweenpoints.html @@ -0,0 +1,18 @@ + + + + + ++ Returns TRUE if a vector is between 2 points +
++
+ + + \ No newline at end of file diff --git a/doc/doc_files/wheelisfront.html b/doc/doc_files/wheelisfront.html new file mode 100644 index 0000000..e599cae --- /dev/null +++ b/doc/doc_files/wheelisfront.html @@ -0,0 +1,18 @@ + + + + + ++ Returns TRUE if a wheel is set as a front wheel +
++
+ + + \ No newline at end of file diff --git a/rcbasic_build/rcbasic4_changes.ods b/rcbasic_build/rcbasic4_changes.ods index 1ce48eb..03b8f98 100644 Binary files a/rcbasic_build/rcbasic4_changes.ods and b/rcbasic_build/rcbasic4_changes.ods differ diff --git a/rcbasic_build/rcbasic_build.layout b/rcbasic_build/rcbasic_build.layout index cec1ac9..bb32a9e 100755 --- a/rcbasic_build/rcbasic_build.layout +++ b/rcbasic_build/rcbasic_build.layout @@ -2,9 +2,19 @@