diff --git a/doc/files/getactorinversemass.txt b/doc/files/getactorinversemass.txt index f0d430a..1e546ac 100644 --- a/doc/files/getactorinversemass.txt +++ b/doc/files/getactorinversemass.txt @@ -3,4 +3,4 @@ Returns an actor's inverse mass - +#ref SetActorMassProperties diff --git a/doc/files/hasclipboardtext.txt b/doc/files/hasclipboardtext.txt index bd68430..13647b7 100644 --- a/doc/files/hasclipboardtext.txt +++ b/doc/files/hasclipboardtext.txt @@ -1,4 +1,4 @@ #title HasClipboardText [RCBasic Doc] #header function HasClipboardText() - +Returns whether or not there is text in the clipboard. diff --git a/doc/files/hex.txt b/doc/files/hex.txt index 3829236..f7382e4 100644 --- a/doc/files/hex.txt +++ b/doc/files/hex.txt @@ -1,4 +1,4 @@ #title Hex$ [RCBasic Doc] #header function Hex$(n) - +Returns a hexadecimal representation of a number. diff --git a/doc/files/hexval.txt b/doc/files/hexval.txt index 3479219..59e7935 100644 --- a/doc/files/hexval.txt +++ b/doc/files/hexval.txt @@ -1,4 +1,4 @@ #title HexVal [RCBasic Doc] #header function HexVal(n$) - +Returns the integer value of a hexadecimal string. diff --git a/doc/files/hidemouse.txt b/doc/files/hidemouse.txt index 1f56680..7979f54 100644 --- a/doc/files/hidemouse.txt +++ b/doc/files/hidemouse.txt @@ -1,4 +1,4 @@ #title HideMouse [RCBasic Doc] #header sub HideMouse() - +Makes the mouse cursor invisible. diff --git a/doc/files/hidewindow.txt b/doc/files/hidewindow.txt index 9f663c9..8b92349 100644 --- a/doc/files/hidewindow.txt +++ b/doc/files/hidewindow.txt @@ -1,4 +1,6 @@ #title HideWindow [RCBasic Doc] #header sub HideWindow( ) +Sets the window invisible. +#ref ShowWindow WindowIsVisible diff --git a/doc/files/imageexists.txt b/doc/files/imageexists.txt index c493f60..2f62b66 100644 --- a/doc/files/imageexists.txt +++ b/doc/files/imageexists.txt @@ -1,4 +1,4 @@ #title ImageExists [RCBasic Doc] -#header function ImageExists(slot) - +#header function ImageExists(img) +Returns true if img is associated with an allocated image in memory diff --git a/doc/files/incrementmatrixcolumns.txt b/doc/files/incrementmatrixcolumns.txt index 33dfea4..e4d1124 100644 --- a/doc/files/incrementmatrixcolumns.txt +++ b/doc/files/incrementmatrixcolumns.txt @@ -1,4 +1,4 @@ #title IncrementMatrixColumns [RCBasic Doc] #header sub IncrementMatrixColumns(mA, mB, c, num_cols, value) - +Increments all the values in a specified number of columns in matrix mA, starting from column c. The result is stored in matrix mB diff --git a/doc/files/incrementmatrixrows.txt b/doc/files/incrementmatrixrows.txt index fa257a1..e7634d8 100644 --- a/doc/files/incrementmatrixrows.txt +++ b/doc/files/incrementmatrixrows.txt @@ -1,4 +1,4 @@ #title IncrementMatrixRows [RCBasic Doc] #header sub IncrementMatrixRows(mA, mB, r, num_rows, value) - +Increments all the values in a specified number of rows in matrix mA, starting from row r. The result is stored in matrix mB diff --git a/doc/files/inkey.txt b/doc/files/inkey.txt index ef48103..65f8d0d 100644 --- a/doc/files/inkey.txt +++ b/doc/files/inkey.txt @@ -1,4 +1,4 @@ #title InKey [RCBasic Doc] #header function InKey() - +Returns the character value of the key that was pressed. diff --git a/doc/files/input.txt b/doc/files/input.txt index b63ca4b..87f735c 100644 --- a/doc/files/input.txt +++ b/doc/files/input.txt @@ -1,4 +1,4 @@ #title Input$ [RCBasic Doc] #header function Input$(prompt$) - +Returns user input from the console diff --git a/doc/files/insert.txt b/doc/files/insert.txt index a38fa5b..b79be67 100644 --- a/doc/files/insert.txt +++ b/doc/files/insert.txt @@ -1,4 +1,4 @@ #title Insert$ [RCBasic Doc] #header function Insert$(src$, tgt$, pos) - +Returns a string containing str_to_insert$ inserted into src$ at a given position diff --git a/doc/files/insertmatrixcolumns.txt b/doc/files/insertmatrixcolumns.txt index d4a3abc..ce15daa 100644 --- a/doc/files/insertmatrixcolumns.txt +++ b/doc/files/insertmatrixcolumns.txt @@ -1,4 +1,4 @@ #title InsertMatrixColumns [RCBasic Doc] #header function InsertMatrixColumns(mA, c, num_cols) - +Insert a number of empty columns into matrix mA starting at the specified column. diff --git a/doc/files/insertmatrixrows.txt b/doc/files/insertmatrixrows.txt index 1727f83..a2c82d9 100644 --- a/doc/files/insertmatrixrows.txt +++ b/doc/files/insertmatrixrows.txt @@ -1,4 +1,4 @@ #title InsertMatrixRows [RCBasic Doc] #header function InsertMatrixRows(mA, r, num_rows) - +Insert a number of empty rows into matrix mA starting at the specified row. diff --git a/doc/files/instr.txt b/doc/files/instr.txt index 4d85ebc..0494250 100644 --- a/doc/files/instr.txt +++ b/doc/files/instr.txt @@ -1,4 +1,4 @@ #title InStr [RCBasic Doc] #header function InStr(src$, substr$) - +Returns the position in src$ where substr$ is found. If not found it will return -1. diff --git a/doc/files/int.txt b/doc/files/int.txt index 8e2e13c..42a718e 100644 --- a/doc/files/int.txt +++ b/doc/files/int.txt @@ -1,4 +1,4 @@ #title Int [RCBasic Doc] #header function Int(n) - +Returns a number converted to an integer. diff --git a/doc/files/integrateactorvelocities.txt b/doc/files/integrateactorvelocities.txt index 995e6f0..3ed735d 100644 --- a/doc/files/integrateactorvelocities.txt +++ b/doc/files/integrateactorvelocities.txt @@ -1,4 +1,6 @@ #title integrateActorVelocities [RCBasic Doc] #header sub integrateActorVelocities( actor, v_step) +Updates the linear and angular velocities of an actor based on the forces and torques applied to it over a time step. +Note: This is more manual control than most devs will probably need diff --git a/doc/files/interpolate.txt b/doc/files/interpolate.txt index 41193c0..149e3b0 100644 --- a/doc/files/interpolate.txt +++ b/doc/files/interpolate.txt @@ -1,4 +1,4 @@ #title Interpolate [RCBasic Doc] #header Function Interpolate(min_a, max_a, mid_a, min_b, max_b) - +This function returns a value interpolated based on the comparison between a mid value in a range of given min and max values diff --git a/doc/files/invertmatrix.txt b/doc/files/invertmatrix.txt index c6b72a6..a5a2c40 100644 --- a/doc/files/invertmatrix.txt +++ b/doc/files/invertmatrix.txt @@ -1,4 +1,4 @@ #title InvertMatrix [RCBasic Doc] #header function InvertMatrix(mA, mB) - +Stores the inverse matrix of mA in mB diff --git a/doc/files/isequalmatrix.txt b/doc/files/isequalmatrix.txt index 5909dcb..8a45e97 100644 --- a/doc/files/isequalmatrix.txt +++ b/doc/files/isequalmatrix.txt @@ -1,4 +1,4 @@ #title IsEqualMatrix [RCBasic Doc] #header function IsEqualMatrix(mA, mB, tolerance) - +Returns true if matrix mA is within tolerance of matrix mB diff --git a/doc/files/joinmatrixcolumns.txt b/doc/files/joinmatrixcolumns.txt index 7596865..5d2266b 100644 --- a/doc/files/joinmatrixcolumns.txt +++ b/doc/files/joinmatrixcolumns.txt @@ -1,4 +1,4 @@ #title JoinMatrixColumns [RCBasic Doc] #header sub JoinMatrixColumns(mA, mB, mC) - +Appends the columns in matrix mB below matrix mA. diff --git a/doc/files/joinmatrixrows.txt b/doc/files/joinmatrixrows.txt index 79f7f4b..b75bbca 100644 --- a/doc/files/joinmatrixrows.txt +++ b/doc/files/joinmatrixrows.txt @@ -1,4 +1,4 @@ #title JoinMatrixRows [RCBasic Doc] #header sub JoinMatrixRows(mA, mB, mC) - +Appends the rows in matrix mB onto the right of matrix mA. diff --git a/doc/files/joyaxis.txt b/doc/files/joyaxis.txt index 133963e..7234801 100644 --- a/doc/files/joyaxis.txt +++ b/doc/files/joyaxis.txt @@ -1,4 +1,4 @@ #title JoyAxis [RCBasic Doc] #header function JoyAxis(joy_num, joy_axis) - +Returns the value of an axis on a joystick. diff --git a/doc/files/joybutton.txt b/doc/files/joybutton.txt index e291c8c..7aacab7 100644 --- a/doc/files/joybutton.txt +++ b/doc/files/joybutton.txt @@ -1,4 +1,4 @@ #title JoyButton [RCBasic Doc] #header function JoyButton(joy_num, joy_button) - +Returns true if the given button was pressed and false otherwise. diff --git a/doc/files/joyhat.txt b/doc/files/joyhat.txt index bd677fb..5276fd1 100644 --- a/doc/files/joyhat.txt +++ b/doc/files/joyhat.txt @@ -1,4 +1,17 @@ #title JoyHat [RCBasic Doc] #header function JoyHat(joy_num, joy_hat) +Returns the position of the Hat. +Possible Hat Positions +#list ul +#li HAT_CENTERED +#li HAT_LEFT +#li HAT_RIGHT +#li HAT_UP +#li HAT_DOWN +#li HAT_RIGHTUP +#li HAT_RIGHTDOWN +#li HAT_LEFTUP +#li HAT_LEFTDOWN +#/list diff --git a/doc/files/joyname.txt b/doc/files/joyname.txt index d234523..ba4df21 100644 --- a/doc/files/joyname.txt +++ b/doc/files/joyname.txt @@ -1,4 +1,4 @@ #title JoyName$ [RCBasic Doc] #header function JoyName$(joy_num) - +Returns the joystick name. diff --git a/doc/files/joyrumbleplay.txt b/doc/files/joyrumbleplay.txt index 49723c4..c015106 100644 --- a/doc/files/joyrumbleplay.txt +++ b/doc/files/joyrumbleplay.txt @@ -1,4 +1,9 @@ #title JoyRumblePlay [RCBasic Doc] #header sub JoyRumblePlay(joy_num, strength, duration) +Rumbles a joystick at a specified strength for the specifed duration. +#list ul +#li Strength - A value between 0 and 1 +#li Duration - Value is in milliseconds +#/list diff --git a/doc/files/joyrumblestop.txt b/doc/files/joyrumblestop.txt index 5ce95f4..5096027 100644 --- a/doc/files/joyrumblestop.txt +++ b/doc/files/joyrumblestop.txt @@ -1,4 +1,4 @@ #title JoyRumbleStop [RCBasic Doc] #header sub JoyRumbleStop(joy_num) - +Stops the rumble on a joystick diff --git a/doc/files/joystickisconnected.txt b/doc/files/joystickisconnected.txt index d691385..7b7db7a 100644 --- a/doc/files/joystickisconnected.txt +++ b/doc/files/joystickisconnected.txt @@ -1,4 +1,4 @@ #title JoystickIsConnected [RCBasic Doc] #header function JoystickIsConnected(joy_num) - +Returns true if joystick is connected, or false if it isn't. diff --git a/doc/files/joystickishaptic.txt b/doc/files/joystickishaptic.txt index 89381fc..96948a6 100644 --- a/doc/files/joystickishaptic.txt +++ b/doc/files/joystickishaptic.txt @@ -1,4 +1,4 @@ #title JoystickIsHaptic [RCBasic Doc] #header function JoystickIsHaptic(joy_num) - +Returns true if joystick has the ability to rumble. diff --git a/doc/files/key.txt b/doc/files/key.txt index 76feca5..970bd9e 100644 --- a/doc/files/key.txt +++ b/doc/files/key.txt @@ -1,4 +1,4 @@ #title Key [RCBasic Doc] #header function Key(key_code) - +Returns true if the given key was pressed and false otherwise. diff --git a/doc/files/lcase.txt b/doc/files/lcase.txt index 7fe61dd..fb701e7 100644 --- a/doc/files/lcase.txt +++ b/doc/files/lcase.txt @@ -1,4 +1,4 @@ #title Lcase$ [RCBasic Doc] #header function Lcase$(src$) - +Returns src$ converted to a completely lower-case string diff --git a/doc/files/left.txt b/doc/files/left.txt index 3ea0198..e6cc52e 100644 --- a/doc/files/left.txt +++ b/doc/files/left.txt @@ -1,4 +1,4 @@ #title Left$ [RCBasic Doc] #header function Left$(src$, n) - +Returns a substring n characters in length from the left side of the given string. diff --git a/doc/files/len.txt b/doc/files/len.txt index 3933724..edac124 100644 --- a/doc/files/len.txt +++ b/doc/files/len.txt @@ -1,4 +1,8 @@ #title Len [RCBasic Doc] #header function Len(src$) +Returns the number of characters in the given string +Note: This function is the exact same as Length() + +#ref Length diff --git a/doc/files/length.txt b/doc/files/length.txt index 583b3d8..aedb7b1 100644 --- a/doc/files/length.txt +++ b/doc/files/length.txt @@ -1,4 +1,8 @@ #title Length [RCBasic Doc] #header function Length(src$) +Returns the number of characters in the given string +Note: This function is the exact same as Len() + +#ref Length diff --git a/doc/files/lightiscastingshadow.txt b/doc/files/lightiscastingshadow.txt index 6e1bc52..41e92ff 100644 --- a/doc/files/lightiscastingshadow.txt +++ b/doc/files/lightiscastingshadow.txt @@ -1,4 +1,6 @@ #title lightIsCastingShadow [RCBasic Doc] #header function lightIsCastingShadow( actor ) +Returns true if shadow casting is enabled for the given light +#ref SetLightShadowCast diff --git a/doc/files/line.txt b/doc/files/line.txt index 3218a53..bf6c840 100644 --- a/doc/files/line.txt +++ b/doc/files/line.txt @@ -1,4 +1,4 @@ #title Line [RCBasic Doc] #header sub Line(x1, y1, x2, y2) - +Draws a line diff --git a/doc/files/loadfont.txt b/doc/files/loadfont.txt index e8ecfc1..3b94b01 100644 --- a/doc/files/loadfont.txt +++ b/doc/files/loadfont.txt @@ -1,4 +1,4 @@ #title LoadFont [RCBasic Doc] #header function LoadFont(fnt_file$, font_size) - +Returns a font id for a font with glyphs of font_size diff --git a/doc/files/loadimage.txt b/doc/files/loadimage.txt index 0ea157f..e196891 100644 --- a/doc/files/loadimage.txt +++ b/doc/files/loadimage.txt @@ -1,4 +1,4 @@ #title LoadImage [RCBasic Doc] #header function LoadImage( img$ ) - +Returns an image id for an image loaded into memory diff --git a/doc/files/loadimageex.txt b/doc/files/loadimageex.txt index 411a4fa..548970b 100644 --- a/doc/files/loadimageex.txt +++ b/doc/files/loadimageex.txt @@ -1,4 +1,4 @@ #title LoadImageEx [RCBasic Doc] #header function LoadImageEx(img$, colkey) - +Returns an image id for an image loaded into memory diff --git a/doc/files/loadmesh.txt b/doc/files/loadmesh.txt index b81238d..528026b 100644 --- a/doc/files/loadmesh.txt +++ b/doc/files/loadmesh.txt @@ -1,4 +1,36 @@ #title LoadMesh [RCBasic Doc] #header function LoadMesh( mesh_file$ ) +Returns a mesh id for the loaded mesh +Supported formats +#list ul +#li Animated objects: + #list ul + #li B3D files (.b3d, r, skeleton) + #li Microsoft DirectX (.x, r) (binary & text, skeleton) + #li Milkshape (.ms3d, r, skeleton) + #li Quake 3 models (.md3, r, morph) + #li Quake 2 models (.md2, r, morph) + #/list +#li Static objects: + #list ul + #li Irrlicht scenes (.irr, r/w) + #li Irrlicht static meshes (.irrmesh, r/w) + #li 3D Studio meshes (.3ds, r) + #li Alias Wavefront Maya (.obj, r/w) + #li Lightwave Objects (.lwo, r) + #li COLLADA 1.4 (.xml, .dae, r/w) + #li OGRE meshes (.mesh, r) + #li My3DTools 3 (.my3D, r) + #li Pulsar LMTools (.lmts, r) + #li Quake 3 levels (.bsp, r) + #li DeleD (.dmf, r) + #li FSRad oct (.oct, r) + #li Cartography shop 4 (.csm, r) + #li STL 3D files (.stl, r/w) + #li PLY 3D files (.ply, r/w) + #/list +#/list + +#ref LoadMeshFromArchive diff --git a/doc/files/loadmeshfromarchive.txt b/doc/files/loadmeshfromarchive.txt index 930c0b4..709103e 100644 --- a/doc/files/loadmeshfromarchive.txt +++ b/doc/files/loadmeshfromarchive.txt @@ -1,4 +1,36 @@ #title LoadMeshFromArchive [RCBasic Doc] #header function LoadMeshFromArchive( archive$, mesh_file$ ) +Returns a mesh id for the loaded mesh from an archive (*.zip, *.pak, etc.) +Supported formats +#list ul +#li Animated objects: + #list ul + #li B3D files (.b3d, r, skeleton) + #li Microsoft DirectX (.x, r) (binary & text, skeleton) + #li Milkshape (.ms3d, r, skeleton) + #li Quake 3 models (.md3, r, morph) + #li Quake 2 models (.md2, r, morph) + #/list +#li Static objects: + #list ul + #li Irrlicht scenes (.irr, r/w) + #li Irrlicht static meshes (.irrmesh, r/w) + #li 3D Studio meshes (.3ds, r) + #li Alias Wavefront Maya (.obj, r/w) + #li Lightwave Objects (.lwo, r) + #li COLLADA 1.4 (.xml, .dae, r/w) + #li OGRE meshes (.mesh, r) + #li My3DTools 3 (.my3D, r) + #li Pulsar LMTools (.lmts, r) + #li Quake 3 levels (.bsp, r) + #li DeleD (.dmf, r) + #li FSRad oct (.oct, r) + #li Cartography shop 4 (.csm, r) + #li STL 3D files (.stl, r/w) + #li PLY 3D files (.ply, r/w) + #/list +#/list + +#ref LoadMesh diff --git a/doc/files/loadmusic.txt b/doc/files/loadmusic.txt index 97685fa..ffb8ddc 100644 --- a/doc/files/loadmusic.txt +++ b/doc/files/loadmusic.txt @@ -1,4 +1,4 @@ #title LoadMusic [RCBasic Doc] #header sub LoadMusic(music_file$) - +Loads a music track diff --git a/doc/files/loadsound.txt b/doc/files/loadsound.txt index a493bf2..539ae23 100644 --- a/doc/files/loadsound.txt +++ b/doc/files/loadsound.txt @@ -1,4 +1,4 @@ #title LoadSound [RCBasic Doc] #header function LoadSound(snd_file$) - +Returns an id for a loaded audio track diff --git a/doc/files/loadvideo.txt b/doc/files/loadvideo.txt index 76c4666..122d0d1 100644 --- a/doc/files/loadvideo.txt +++ b/doc/files/loadvideo.txt @@ -1,4 +1,4 @@ #title LoadVideo [RCBasic Doc] #header sub LoadVideo(vid$) - +Loads a video track diff --git a/doc/files/log.txt b/doc/files/log.txt index 333ad0c..1cf5563 100644 --- a/doc/files/log.txt +++ b/doc/files/log.txt @@ -1,4 +1,4 @@ #title Log [RCBasic Doc] #header function Log(n) - +Returns the logarithm of a number. diff --git a/doc/files/loopactoranimation.txt b/doc/files/loopactoranimation.txt index b59dd23..9b049a4 100644 --- a/doc/files/loopactoranimation.txt +++ b/doc/files/loopactoranimation.txt @@ -1,4 +1,4 @@ #title loopActorAnimation [RCBasic Doc] #header sub loopActorAnimation( actor, flag ) - +Enables or disables actor animation loop diff --git a/doc/files/ltrim.txt b/doc/files/ltrim.txt index 7875047..df9fce2 100644 --- a/doc/files/ltrim.txt +++ b/doc/files/ltrim.txt @@ -1,4 +1,4 @@ #title Ltrim$ [RCBasic Doc] #header function Ltrim$(src$) - +Returns src$ with all the spaces before the first non-space character removed. diff --git a/doc/files/makedir.txt b/doc/files/makedir.txt index db76b7c..98c60c8 100644 --- a/doc/files/makedir.txt +++ b/doc/files/makedir.txt @@ -1,4 +1,4 @@ #title MakeDir [RCBasic Doc] #header function MakeDir(p$) - +Creates a new directory. diff --git a/doc/files/materialisaplhablend.txt b/doc/files/materialisaplhablend.txt index e81c4d1..0ef6991 100644 --- a/doc/files/materialisaplhablend.txt +++ b/doc/files/materialisaplhablend.txt @@ -1,4 +1,4 @@ #title materialIsAplhaBlend [RCBasic Doc] #header function materialIsAplhaBlend( material_id) - +Returns true if alpha blending is enabled for a material diff --git a/doc/files/materialisgouraudshaded.txt b/doc/files/materialisgouraudshaded.txt index 4f086f8..f6b94b9 100644 --- a/doc/files/materialisgouraudshaded.txt +++ b/doc/files/materialisgouraudshaded.txt @@ -1,4 +1,4 @@ #title materialIsGouraudShaded [RCBasic Doc] #header function materialIsGouraudShaded( material_id) - +Returns true if material is set to goraud shading diff --git a/doc/files/materialislit.txt b/doc/files/materialislit.txt index 7097a8f..9607570 100644 --- a/doc/files/materialislit.txt +++ b/doc/files/materialislit.txt @@ -1,4 +1,6 @@ #title materialIsLit [RCBasic Doc] #header function materialIsLit( material_id) +Returns true if a material is affected by lights in the scene +#ref SetMaterialLighting diff --git a/doc/files/materialisnormalized.txt b/doc/files/materialisnormalized.txt index 7c57568..fdd280f 100644 --- a/doc/files/materialisnormalized.txt +++ b/doc/files/materialisnormalized.txt @@ -1,4 +1,4 @@ #title materialIsNormalized [RCBasic Doc] #header function materialIsNormalized( material_id) - +Returns true if material has normalized normals diff --git a/doc/files/materialispointcloud.txt b/doc/files/materialispointcloud.txt index 9598967..3c703f3 100644 --- a/doc/files/materialispointcloud.txt +++ b/doc/files/materialispointcloud.txt @@ -1,4 +1,4 @@ #title materialIsPointCloud [RCBasic Doc] #header function materialIsPointCloud( material_id) - +Returns true if material is set to render with point cloud diff --git a/doc/files/materialistransparent.txt b/doc/files/materialistransparent.txt index 1a83a0a..92bdce5 100644 --- a/doc/files/materialistransparent.txt +++ b/doc/files/materialistransparent.txt @@ -1,4 +1,4 @@ #title materialIsTransparent [RCBasic Doc] #header function materialIsTransparent( material_id) - +Returns true if material is transparent diff --git a/doc/files/materialiswireframe.txt b/doc/files/materialiswireframe.txt index 4dce2fa..aafe744 100644 --- a/doc/files/materialiswireframe.txt +++ b/doc/files/materialiswireframe.txt @@ -1,4 +1,4 @@ #title materialIsWireframe [RCBasic Doc] #header function materialIsWireframe( material_id) - +Returns true if the material is rendered with non-filled triangles diff --git a/doc/files/matrixfrombuffer.txt b/doc/files/matrixfrombuffer.txt index 6086349..a65d2a3 100644 --- a/doc/files/matrixfrombuffer.txt +++ b/doc/files/matrixfrombuffer.txt @@ -1,4 +1,6 @@ #title MatrixFromBuffer [RCBasic Doc] #header sub MatrixFromBuffer(mA, r, c, ByRef buffer) +Creates a matrix from an array. +NOTE: buffer must have the same number of dimensions as the desired matrix for the structure to remain intact. diff --git a/doc/files/matrixvalue.txt b/doc/files/matrixvalue.txt index 013e5ba..a6240ad 100644 --- a/doc/files/matrixvalue.txt +++ b/doc/files/matrixvalue.txt @@ -1,4 +1,4 @@ #title MatrixValue [RCBasic Doc] #header function MatrixValue(mA, r, c) - +Returns the value stored at the given row and column in the matrix diff --git a/doc/files/max.txt b/doc/files/max.txt index 1a2dede..31553d6 100644 --- a/doc/files/max.txt +++ b/doc/files/max.txt @@ -1,4 +1,6 @@ #title Max [RCBasic Doc] #header function Max(a, b) +Returns the highest of two numbers. +#ref Min diff --git a/doc/files/maximizewindow.txt b/doc/files/maximizewindow.txt index 437ccab..112c9e6 100644 --- a/doc/files/maximizewindow.txt +++ b/doc/files/maximizewindow.txt @@ -1,4 +1,4 @@ #title MaximizeWindow [RCBasic Doc] #header sub MaximizeWindow() - +Maximizes the window diff --git a/doc/files/messagebox.txt b/doc/files/messagebox.txt index 1756441..0097a88 100644 --- a/doc/files/messagebox.txt +++ b/doc/files/messagebox.txt @@ -1,4 +1,4 @@ #title MessageBox [RCBasic Doc] #header function MessageBox(title$, msg$) - +Displays a message box diff --git a/doc/files/mid.txt b/doc/files/mid.txt index 8b14040..353ca46 100644 --- a/doc/files/mid.txt +++ b/doc/files/mid.txt @@ -1,4 +1,4 @@ #title Mid$ [RCBasic Doc] #header function Mid$(src$, start, n) - +Returns a substring n characters long starting at start pos. diff --git a/doc/files/min.txt b/doc/files/min.txt index 6828ac4..a734025 100644 --- a/doc/files/min.txt +++ b/doc/files/min.txt @@ -1,4 +1,7 @@ #title Min [RCBasic Doc] #header function Min(a, b) +Returns the lowest of two numbers. + +#ref Max diff --git a/doc/files/minimizewindow.txt b/doc/files/minimizewindow.txt index 9644318..3bbbc5a 100644 --- a/doc/files/minimizewindow.txt +++ b/doc/files/minimizewindow.txt @@ -1,4 +1,4 @@ #title MinimizeWindow [RCBasic Doc] #header sub MinimizeWindow() - +Minimizes the window diff --git a/doc/files/mousebutton.txt b/doc/files/mousebutton.txt index fb4f088..01f12e8 100644 --- a/doc/files/mousebutton.txt +++ b/doc/files/mousebutton.txt @@ -1,4 +1,4 @@ #title MouseButton [RCBasic Doc] #header function MouseButton(mb) - +Returns true if mouse button is pressed diff --git a/doc/files/mouseisvisible.txt b/doc/files/mouseisvisible.txt index 1360aa6..bedf245 100644 --- a/doc/files/mouseisvisible.txt +++ b/doc/files/mouseisvisible.txt @@ -1,4 +1,6 @@ #title MouseIsVisible [RCBasic Doc] #header function MouseIsVisible() +Returns true if mouse cursor is shown +#ref ShowMouse HideMouse diff --git a/doc/files/mousewheelx.txt b/doc/files/mousewheelx.txt index 09c476d..2f86834 100644 --- a/doc/files/mousewheelx.txt +++ b/doc/files/mousewheelx.txt @@ -1,4 +1,4 @@ #title MouseWheelX [RCBasic Doc] #header function MouseWheelX() - +Returns the value of the x axis on the mouse wheel diff --git a/doc/files/mousewheely.txt b/doc/files/mousewheely.txt index ee42d6d..d7af7ae 100644 --- a/doc/files/mousewheely.txt +++ b/doc/files/mousewheely.txt @@ -1,4 +1,4 @@ #title MouseWheelY [RCBasic Doc] #header function MouseWheelY() - +Returns the value of the y axis on the mouse wheel diff --git a/doc/files/mousex.txt b/doc/files/mousex.txt index a8ac3ec..4fc5a2b 100644 --- a/doc/files/mousex.txt +++ b/doc/files/mousex.txt @@ -1,4 +1,4 @@ #title MouseX [RCBasic Doc] #header function MouseX() - +Returns the mouse x position diff --git a/doc/files/mousey.txt b/doc/files/mousey.txt index 867d7b4..a919394 100644 --- a/doc/files/mousey.txt +++ b/doc/files/mousey.txt @@ -1,4 +1,4 @@ #title MouseY [RCBasic Doc] #header function MouseY() - +Returns the mouse y position diff --git a/doc/files/movefile.txt b/doc/files/movefile.txt index b1000a6..c4bffa3 100644 --- a/doc/files/movefile.txt +++ b/doc/files/movefile.txt @@ -1,4 +1,6 @@ #title MoveFile [RCBasic Doc] #header function MoveFile(src$, dst$) +Moves a file on the system. +Returns true if the file was able to be moved and false if it wasn't diff --git a/doc/files/multiplymatrix.txt b/doc/files/multiplymatrix.txt index 02f194d..fd14713 100644 --- a/doc/files/multiplymatrix.txt +++ b/doc/files/multiplymatrix.txt @@ -1,4 +1,4 @@ #title MultiplyMatrix [RCBasic Doc] #header function MultiplyMatrix(mA, mB, mC) - +Multiply matrix mA and mB and store the result in mC diff --git a/doc/files/musicexists.txt b/doc/files/musicexists.txt index a0c8e39..f6ec489 100644 --- a/doc/files/musicexists.txt +++ b/doc/files/musicexists.txt @@ -1,4 +1,4 @@ #title MusicExists [RCBasic Doc] #header function MusicExists() - +Returns true if there is a music track loaded diff --git a/doc/files/musicisplaying.txt b/doc/files/musicisplaying.txt index 7a13f25..dd79f4e 100644 --- a/doc/files/musicisplaying.txt +++ b/doc/files/musicisplaying.txt @@ -1,4 +1,4 @@ #title MusicIsPlaying [RCBasic Doc] #header function MusicIsPlaying() - +Returns true if the music track is currently playing diff --git a/doc/files/numaccels.txt b/doc/files/numaccels.txt index a88ead3..43a105a 100644 --- a/doc/files/numaccels.txt +++ b/doc/files/numaccels.txt @@ -1,4 +1,4 @@ #title NumAccels [RCBasic Doc] #header function NumAccels() - +Returns the number of accelerometer sensors detected diff --git a/doc/files/prefpath.txt b/doc/files/prefpath.txt index 0dfc3ff..417b467 100644 --- a/doc/files/prefpath.txt +++ b/doc/files/prefpath.txt @@ -1,4 +1,4 @@ #title PrefPath$ [RCBasic Doc] #header function PrefPath$(org_name$, app_name$) - +Returns the preferred path for storing files. diff --git a/doc/files/rgb.txt b/doc/files/rgb.txt index 327923b..26ad391 100644 --- a/doc/files/rgb.txt +++ b/doc/files/rgb.txt @@ -1,4 +1,4 @@ #title RGB [RCBasic Doc] #header function RGB(r,g,b) - +Returns a 32-bit color value. diff --git a/doc/files/rgba.txt b/doc/files/rgba.txt index afebfcb..5b0f46c 100644 --- a/doc/files/rgba.txt +++ b/doc/files/rgba.txt @@ -1,4 +1,4 @@ #title RGBA [RCBasic Doc] #header function RGBA(r,g,b,a) - +Returns a 32-bit color value. diff --git a/doc/files/right.txt b/doc/files/right.txt index 2f571dd..c27c1e7 100644 --- a/doc/files/right.txt +++ b/doc/files/right.txt @@ -1,4 +1,4 @@ #title Right$ [RCBasic Doc] #header function Right$(src$, n) - +Returns n number of characters from the right side of src$. diff --git a/doc/files/rotateactor.txt b/doc/files/rotateactor.txt index 16db805..bea4d34 100644 --- a/doc/files/rotateactor.txt +++ b/doc/files/rotateactor.txt @@ -1,4 +1,6 @@ #title RotateActor [RCBasic Doc] #header sub RotateActor( actor, x, y, z ) +Rotates and actor a given number of degrees from its current orientation +#ref SetActorRotation GetActorRotation diff --git a/doc/files/rotatecamera.txt b/doc/files/rotatecamera.txt index 8dd2d7f..d4ce338 100644 --- a/doc/files/rotatecamera.txt +++ b/doc/files/rotatecamera.txt @@ -1,4 +1,6 @@ #title RotateCamera [RCBasic Doc] #header sub RotateCamera( x, y, z) +Rotates the camera a given number of degrees from its current orientation +#ref SetCameraRotation GetCameraRotation diff --git a/doc/files/round.txt b/doc/files/round.txt index c6dade7..2ede955 100644 --- a/doc/files/round.txt +++ b/doc/files/round.txt @@ -1,4 +1,4 @@ #title Round [RCBasic Doc] #header function Round(n) - +Rounds n to the nearest whole number. diff --git a/doc/files/rtrim.txt b/doc/files/rtrim.txt index ff3ab2c..e184ddc 100644 --- a/doc/files/rtrim.txt +++ b/doc/files/rtrim.txt @@ -1,4 +1,4 @@ #title Rtrim$ [RCBasic Doc] #header function Rtrim$(src$) - +Returns src$ with all the spaces after the last non-space character removed. diff --git a/doc/files/runtime.txt b/doc/files/runtime.txt index fdfdbb5..0e834dd 100644 --- a/doc/files/runtime.txt +++ b/doc/files/runtime.txt @@ -1,4 +1,4 @@ #title Runtime$ [RCBasic Doc] #header function Runtime$() - +Returns the path to the RCBasic runtime that launched the current program diff --git a/doc/files/runtime_utility_message.txt b/doc/files/runtime_utility_message.txt index 711b420..6d9adb7 100644 --- a/doc/files/runtime_utility_message.txt +++ b/doc/files/runtime_utility_message.txt @@ -1,4 +1,6 @@ #title Runtime_Utility_Message$ [RCBasic Doc] #header function Runtime_Utility_Message$(arg$) +Passes arg$ to the rc_intern_runtime_utility() function in the rc_media.h file. The function returns a string. +Note: On IOS there a file in the project called rcbasic_ios_native.h which is already setup for you to add your C++ code. diff --git a/doc/files/setactorlinearvelocitylocal.txt b/doc/files/setactorlinearvelocitylocal.txt index 7dcb77b..a662ba8 100644 --- a/doc/files/setactorlinearvelocitylocal.txt +++ b/doc/files/setactorlinearvelocitylocal.txt @@ -1,4 +1,6 @@ #title setActorLinearVelocityLocal [RCBasic Doc] #header sub setActorLinearVelocityLocal( actor, x, y, z) +Sets actor's linear velocity +#ref GetActorLinearVelocityLocal SetActorLinearVelocityWorld diff --git a/doc/files/setactorlinearvelocityworld.txt b/doc/files/setactorlinearvelocityworld.txt index a583ff3..eaf790a 100644 --- a/doc/files/setactorlinearvelocityworld.txt +++ b/doc/files/setactorlinearvelocityworld.txt @@ -1,4 +1,7 @@ #title setActorLinearVelocityWorld [RCBasic Doc] #header sub setActorLinearVelocityWorld( actor, x, y, z) +Sets actor's linear velocity + +#ref SetActorLinearVelocityLocal GetActorLinearVelocityWorld diff --git a/doc/files/setactormassproperties.txt b/doc/files/setactormassproperties.txt index f84275d..8ed0140 100644 --- a/doc/files/setactormassproperties.txt +++ b/doc/files/setactormassproperties.txt @@ -1,4 +1,17 @@ #title setActorMassProperties [RCBasic Doc] #header sub setActorMassProperties( actor, mass, inertia_x, inertia_y, inertia_z) +Set the mass and local inertia of an actor. This is crucial for defining how the actor behaves under the influence of forces and torques, especially when it comes to simulating realistic motion and rotation. +Mass +#list ul +#li The mass of an actor defines how much it resists changes in its motion when forces are applied. A heavier object will require more force to accelerate or decelerate compared to a lighter object. +#/list + +Inertial +#list ul +#li The local inertia is a vector that represents how the mass is distributed within the actor relative to its center of mass. It affects how the actor resists rotational forces (torques). +#li An object with a larger inertia value along a specific axis will rotate more slowly when a torque is applied in that direction, and vice versa. +#/list + +#ref GetActorLocalInertia GetActorInverseMass diff --git a/doc/files/setactormaterial.txt b/doc/files/setactormaterial.txt index d6cf9ce..29ce970 100644 --- a/doc/files/setactormaterial.txt +++ b/doc/files/setactormaterial.txt @@ -1,4 +1,8 @@ #title setActorMaterial [RCBasic Doc] #header sub setActorMaterial( actor, material_num, material_id) +Sets a material on an actor +Note: Generally you just want to set material zero but actors can have multiple materials depending on the model format + +#ref GetActorMaterial diff --git a/doc/files/setactormaterialflag.txt b/doc/files/setactormaterialflag.txt index 18fbb8c..96ebeff 100644 --- a/doc/files/setactormaterialflag.txt +++ b/doc/files/setactormaterialflag.txt @@ -1,4 +1,32 @@ #title setActorMaterialFlag [RCBasic Doc] #header sub setActorMaterialFlag( actor, flag, flag_value) +Sets the value of an actor's material flag. +Note: The material on this would be material 0. To set other material flag's you need to get a reference to the actor's material with GetActorMaterial(). + +Possible values for flag: +#list +#li MATERIAL_FLAG_WIREFRAME  +#li MATERIAL_FLAG_POINTCLOUD  +#li MATERIAL_FLAG_GOURAUD_SHADING  +#li MATERIAL_FLAG_LIGHTING  +#li MATERIAL_FLAG_ZBUFFER  +#li MATERIAL_FLAG_ZWRITE_ENABLE  +#li MATERIAL_FLAG_BACK_FACE_CULLING  +#li MATERIAL_FLAG_FRONT_FACE_CULLING  +#li MATERIAL_FLAG_BILINEAR_FILTER  +#li MATERIAL_FLAG_TRILINEAR_FILTER  +#li MATERIAL_FLAG_ANISOTROPIC_FILTER  +#li MATERIAL_FLAG_FOG_ENABLE  +#li MATERIAL_FLAG_NORMALIZE_NORMALS  +#li MATERIAL_FLAG_TEXTURE_WRAP  +#li MATERIAL_FLAG_ANTI_ALIASING  +#li MATERIAL_FLAG_COLOR_MASK  +#li MATERIAL_FLAG_COLOR_MATERIAL  +#li MATERIAL_FLAG_USE_MIP_MAPS  +#li MATERIAL_FLAG_BLEND_OPERATION  +#li MATERIAL_FLAG_POLYGON_OFFSET  +#/list + +#ref GetActorMaterialFlag GetActorMaterial diff --git a/doc/files/setactormd2animation.txt b/doc/files/setactormd2animation.txt index 0edae0a..b90d1fe 100644 --- a/doc/files/setactormd2animation.txt +++ b/doc/files/setactormd2animation.txt @@ -1,4 +1,31 @@ #title SetActorMD2Animation [RCBasic Doc] #header sub SetActorMD2Animation( actor, anim ) +Sets the current animation for an *.md2 model +Possible Animations +#list ul +#li MD2_ANIMATION_STAND +#li MD2_ANIMATION_RUN +#li MD2_ANIMATION_ATTACK +#li MD2_ANIMATION_PAIN_A +#li MD2_ANIMATION_PAIN_B +#li MD2_ANIMATION_PAIN_C +#li MD2_ANIMATION_JUMP +#li MD2_ANIMATION_FLIP +#li MD2_ANIMATION_SALUTE +#li MD2_ANIMATION_FALLBACK +#li MD2_ANIMATION_WAVE +#li MD2_ANIMATION_POINT +#li MD2_ANIMATION_CROUCH_STAND +#li MD2_ANIMATION_CROUCH_WALK +#li MD2_ANIMATION_CROUCH_ATTACK +#li MD2_ANIMATION_CROUCH_PAIN +#li MD2_ANIMATION_CROUCH_DEATH +#li MD2_ANIMATION_DEATH_FALLBACK +#li MD2_ANIMATION_DEATH_FALLFORWARD +#li MD2_ANIMATION_DEATH_FALLBACKSLOW +#li MD2_ANIMATION_BOOM +#/list + +#ref SetActorMD2AnimationByName diff --git a/doc/files/setactormd2animationbyname.txt b/doc/files/setactormd2animationbyname.txt index 3e9a768..46e598d 100644 --- a/doc/files/setactormd2animationbyname.txt +++ b/doc/files/setactormd2animationbyname.txt @@ -1,4 +1,7 @@ #title SetActorMD2AnimationByName [RCBasic Doc] #header sub SetActorMD2AnimationByName( actor, anim_name$ ) +Sets the current animation for an *.md2 model + +#ref SetActorMD2Animation diff --git a/doc/files/setactorposition.txt b/doc/files/setactorposition.txt index 3abd393..5ca46d9 100644 --- a/doc/files/setactorposition.txt +++ b/doc/files/setactorposition.txt @@ -1,4 +1,6 @@ #title SetActorPosition [RCBasic Doc] #header sub SetActorPosition( actor, x, y, z ) +Sets the absolute position of an actor +#ref TranslateActorLocal TranslateActorWorld GetActorPosition diff --git a/doc/files/setactorrotation.txt b/doc/files/setactorrotation.txt index 649e2c3..b0db8eb 100644 --- a/doc/files/setactorrotation.txt +++ b/doc/files/setactorrotation.txt @@ -1,4 +1,6 @@ #title SetActorRotation [RCBasic Doc] #header sub SetActorRotation( actor, x, y, z ) +Sets the rotation of an actor around each axis +#ref RotateActor GetActorRotation diff --git a/doc/files/setactorscale.txt b/doc/files/setactorscale.txt index d8cadea..f76d172 100644 --- a/doc/files/setactorscale.txt +++ b/doc/files/setactorscale.txt @@ -1,4 +1,6 @@ #title SetActorScale [RCBasic Doc] #header sub SetActorScale( actor, x, y, z ) +Sets the scale of an actor +#ref ScaleActor GetActorScale diff --git a/doc/files/setactorsleepthresholds.txt b/doc/files/setactorsleepthresholds.txt index 34ca887..d6d9fed 100644 --- a/doc/files/setactorsleepthresholds.txt +++ b/doc/files/setactorsleepthresholds.txt @@ -1,4 +1,6 @@ #title setActorSleepThresholds [RCBasic Doc] #header sub setActorSleepThresholds( actor, linear, angular) +Sets the linear and angular deactivation thresholds for an actor +#ref GetActorLinearSleepThreshold GetActorAngularSleepThreshold diff --git a/doc/files/setactorsolid.txt b/doc/files/setactorsolid.txt index 2dcf2e2..b0d24c7 100644 --- a/doc/files/setactorsolid.txt +++ b/doc/files/setactorsolid.txt @@ -1,4 +1,8 @@ #title SetActorSolid [RCBasic Doc] #header sub SetActorSolid(actor, flag) +Sets whether an actor has physics and collision response applied to it +Note: Collision detection will still work for non solid actors + +#ref ActorIsSolid diff --git a/doc/files/setactortexture.txt b/doc/files/setactortexture.txt index ad569e4..d80baf8 100644 --- a/doc/files/setactortexture.txt +++ b/doc/files/setactortexture.txt @@ -1,4 +1,6 @@ #title setActorTexture [RCBasic Doc] #header sub setActorTexture( actor, layer, image_id) +Sets the texture for an actor's default material +Note: Generally you want to use texture layer 0 diff --git a/doc/files/setactorvisible.txt b/doc/files/setactorvisible.txt index 8750879..fb889ba 100644 --- a/doc/files/setactorvisible.txt +++ b/doc/files/setactorvisible.txt @@ -1,4 +1,6 @@ #title SetActorVisible [RCBasic Doc] #header sub SetActorVisible( actor, flag ) +Sets whether the actor is visible in the scene +#ref ActorIsVisible diff --git a/doc/files/setbilinearfilter.txt b/doc/files/setbilinearfilter.txt index 1c9c7d4..9722876 100644 --- a/doc/files/setbilinearfilter.txt +++ b/doc/files/setbilinearfilter.txt @@ -1,4 +1,4 @@ #title setBilinearFilter [RCBasic Doc] #header sub setBilinearFilter( flag ) - +Enables or disables the bilinear filter for drawing 2D images diff --git a/doc/files/setcamerafarvalue.txt b/doc/files/setcamerafarvalue.txt index b0fa625..a8d0231 100644 --- a/doc/files/setcamerafarvalue.txt +++ b/doc/files/setcamerafarvalue.txt @@ -1,4 +1,6 @@ #title SetCameraFarValue [RCBasic Doc] #header sub SetCameraFarValue( zf ) +Sets the distance to the camera far plane +#ref GetCameraFarValue diff --git a/doc/files/setcamerafov.txt b/doc/files/setcamerafov.txt index 3e4ade2..19caf7d 100644 --- a/doc/files/setcamerafov.txt +++ b/doc/files/setcamerafov.txt @@ -1,4 +1,6 @@ #title SetCameraFOV [RCBasic Doc] #header sub SetCameraFOV( fov ) +Sets the camera's field of view +#ref GetCameraFOV diff --git a/doc/files/setcameranearvalue.txt b/doc/files/setcameranearvalue.txt index 56c78be..d70f896 100644 --- a/doc/files/setcameranearvalue.txt +++ b/doc/files/setcameranearvalue.txt @@ -1,4 +1,6 @@ #title SetCameraNearValue [RCBasic Doc] #header sub SetCameraNearValue( zn ) +Sets the distance of the camera near plane +#ref GetCameraNearValue diff --git a/doc/files/setcameraposition.txt b/doc/files/setcameraposition.txt index 5c73b0b..96eb8db 100644 --- a/doc/files/setcameraposition.txt +++ b/doc/files/setcameraposition.txt @@ -1,4 +1,6 @@ #title SetCameraPosition [RCBasic Doc] #header sub SetCameraPosition( x, y, z) +Sets the absolute position of the camera in the scene +#ref TranslateCamera GetCameraPosition diff --git a/doc/files/setcamerarotation.txt b/doc/files/setcamerarotation.txt index f240439..9cbc9f3 100644 --- a/doc/files/setcamerarotation.txt +++ b/doc/files/setcamerarotation.txt @@ -1,4 +1,6 @@ #title SetCameraRotation [RCBasic Doc] #header sub SetCameraRotation( x, y, z) +Sets the rotation of the camera around each axis +#ref RotateCamera GetCameraRotation diff --git a/doc/files/setcanvasalpha.txt b/doc/files/setcanvasalpha.txt index 7a26a70..80b4aef 100644 --- a/doc/files/setcanvasalpha.txt +++ b/doc/files/setcanvasalpha.txt @@ -1,4 +1,4 @@ #title SetCanvasAlpha [RCBasic Doc] #header sub SetCanvasAlpha(c_num, a) - +Sets the alpha blending value for a canvas diff --git a/doc/files/setcanvascolormod.txt b/doc/files/setcanvascolormod.txt index 8f7ac62..c03eaba 100644 --- a/doc/files/setcanvascolormod.txt +++ b/doc/files/setcanvascolormod.txt @@ -1,4 +1,4 @@ #title SetCanvasColorMod [RCBasic Doc] #header sub SetCanvasColorMod(c_num, c) - +Sets the color modulation value for a canvas diff --git a/doc/files/setcanvasoffset.txt b/doc/files/setcanvasoffset.txt index 57a6d0c..57fa5fa 100644 --- a/doc/files/setcanvasoffset.txt +++ b/doc/files/setcanvasoffset.txt @@ -1,4 +1,8 @@ #title SetCanvasOffset [RCBasic Doc] #header sub SetCanvasOffset(c_num, x, y) +Sets the offset of a canvas +The canvas offset is what part of the canvas is visible during rendering. + +#ref GetCanvasOffset diff --git a/doc/files/setcanvasvisible.txt b/doc/files/setcanvasvisible.txt index 5b6aa06..7d88749 100644 --- a/doc/files/setcanvasvisible.txt +++ b/doc/files/setcanvasvisible.txt @@ -1,4 +1,6 @@ #title SetCanvasVisible [RCBasic Doc] #header sub SetCanvasVisible(c_num, flag) +Sets whether a canvas is shown or not. +#ref CanvasIsVisible diff --git a/doc/files/setchanneldistance.txt b/doc/files/setchanneldistance.txt index cfb814d..1936dd3 100644 --- a/doc/files/setchanneldistance.txt +++ b/doc/files/setchanneldistance.txt @@ -1,4 +1,6 @@ #title SetChannelDistance [RCBasic Doc] #header function SetChannelDistance(channel, dist_value) +Set a volume adjustment effect due to distance. distance must be a value between 0 and 255. Returns 0 on error. +NOTE: Setting distance to 0 will cancel the effect diff --git a/doc/files/setchannelpanning.txt b/doc/files/setchannelpanning.txt index e4840ca..64788b9 100644 --- a/doc/files/setchannelpanning.txt +++ b/doc/files/setchannelpanning.txt @@ -1,4 +1,7 @@ #title SetChannelPanning [RCBasic Doc] #header function SetChannelPanning(channel, left_value, right_value) +Set Panning effect for channel. left_value and right_value must be a value between 0 and 255. Returns 0 on error. + +NOTE: Setting both left and right to 255 will cancel the pan effect diff --git a/doc/files/setchannelspaceposition.txt b/doc/files/setchannelspaceposition.txt index 53f1868..670c73d 100644 --- a/doc/files/setchannelspaceposition.txt +++ b/doc/files/setchannelspaceposition.txt @@ -1,4 +1,8 @@ #title SetChannelSpacePosition [RCBasic Doc] #header function SetChannelSpacePosition(channel, angle, distance) +Simulates audio in 3D space +Angle 0 is in front of the listener and increases clockwise + +#ref SetChannelDistance SetChannelPanning diff --git a/doc/files/setchannelvolume.txt b/doc/files/setchannelvolume.txt index 1d66782..98670a2 100644 --- a/doc/files/setchannelvolume.txt +++ b/doc/files/setchannelvolume.txt @@ -1,4 +1,4 @@ #title SetChannelVolume [RCBasic Doc] #header sub SetChannelVolume(channel, vol) - +Sets the volume of the audio on a channel diff --git a/doc/files/setclearcolor.txt b/doc/files/setclearcolor.txt index 3989e96..aa84c34 100644 --- a/doc/files/setclearcolor.txt +++ b/doc/files/setclearcolor.txt @@ -1,4 +1,6 @@ #title SetClearColor [RCBasic Doc] #header sub SetClearColor(c) +Sets the color that a canvas is cleared to on ClearCanvas() +#ref ClearCanvas diff --git a/doc/files/setclipboardtext.txt b/doc/files/setclipboardtext.txt index a188ec5..2a338f1 100644 --- a/doc/files/setclipboardtext.txt +++ b/doc/files/setclipboardtext.txt @@ -1,4 +1,4 @@ #title SetClipboardText [RCBasic Doc] #header sub SetClipboardText(txt$) - +Sets the clipboard text. diff --git a/doc/files/setcolor.txt b/doc/files/setcolor.txt index b292335..0896c08 100644 --- a/doc/files/setcolor.txt +++ b/doc/files/setcolor.txt @@ -1,4 +1,4 @@ #title SetColor [RCBasic Doc] #header sub SetColor(c) - +Sets the current draw color diff --git a/doc/files/setenv.txt b/doc/files/setenv.txt index ee2ad06..7c62e28 100644 --- a/doc/files/setenv.txt +++ b/doc/files/setenv.txt @@ -1,4 +1,6 @@ #title SetEnv [RCBasic Doc] #header sub SetEnv(var$, value$) +Sets the value of an environment variable +#ref Env$ diff --git a/doc/files/setfont.txt b/doc/files/setfont.txt index 0bdc24d..19fcfb9 100644 --- a/doc/files/setfont.txt +++ b/doc/files/setfont.txt @@ -1,4 +1,6 @@ #title SetFont [RCBasic Doc] -#header sub SetFont(slot) +#header sub SetFont(fnt_id) +Sets the active font for text rendering +#ref DrawText diff --git a/doc/files/setgravity3d.txt b/doc/files/setgravity3d.txt index 4d5fd88..ea6372b 100644 --- a/doc/files/setgravity3d.txt +++ b/doc/files/setgravity3d.txt @@ -1,4 +1,4 @@ #title SetGravity3D [RCBasic Doc] #header sub SetGravity3D(x, y, z) - +Sets the world gravity diff --git a/doc/files/sethingelimit.txt b/doc/files/sethingelimit.txt index 4b2264b..ac0c24f 100644 --- a/doc/files/sethingelimit.txt +++ b/doc/files/sethingelimit.txt @@ -1,4 +1,16 @@ #title setHingeLimit [RCBasic Doc] #header sub setHingeLimit( constraint_id, low, high, softness, bias_factor, relaxation_factor) +Defines the angular limits of the hinge's rotation. A hinge constraint allows two actors (or one actor and the world) to rotate around a single axis, similar to a door hinge. This function restricts how far this rotation can go by setting minimum and maximum angles. +By default, if no limits are applied, the hinge can rotate freely around the axis. + +#list ul +#li low: This is the minimum angular limit. It defines the smallest angle that the hinge can rotate to in the negative direction. +#li high: This is the maximum angular limit. It defines the largest angle that the hinge can rotate to in the positive direction. +#li softness: Controls how "soft" the limit is. A value closer to 0 results in a hard limit (instant stop when the limit is reached), while a value closer to 1 allows some "give" before the limit fully takes effect, making the motion smoother as the limit is approached. +#li bias_factor: Helps to correct drift or penetration by applying a correction bias when the hinge reaches the limit. A higher value will apply a stronger bias to correct errors in the position. +#li relaxation_factor: Controls how the hinge behaves once the limit is reached. A value closer to 1 results in faster relaxation after hitting the limit, while a lower value makes the motion more rigid. +#/list + +#ref GetHingeLimitBiasFactor GetHingeLimitRelaxationFactor GetHingeLimitSign GetHingeSolveLimit diff --git a/doc/files/setidentitymatrix.txt b/doc/files/setidentitymatrix.txt index b0f6998..c6b8898 100644 --- a/doc/files/setidentitymatrix.txt +++ b/doc/files/setidentitymatrix.txt @@ -1,4 +1,6 @@ #title SetIdentityMatrix [RCBasic Doc] #header sub SetIdentityMatrix(mA, n) +Sets matrix mA to an identity matrix of n rows and n columns. +For most transform operations (ie. translate, rotate, and scale) it is recommended to start from and identity matrix diff --git a/doc/files/setimagealpha.txt b/doc/files/setimagealpha.txt index 6f1f986..e147dc8 100644 --- a/doc/files/setimagealpha.txt +++ b/doc/files/setimagealpha.txt @@ -1,4 +1,6 @@ #title SetImageAlpha [RCBasic Doc] #header sub SetImageAlpha(slot, a) +Sets the alpha blending value for an image. This value only applies in 2D drawing commands. +#ref GetImageAlpha diff --git a/doc/files/setimagecolormod.txt b/doc/files/setimagecolormod.txt index 7a0fc77..3bdeb4a 100644 --- a/doc/files/setimagecolormod.txt +++ b/doc/files/setimagecolormod.txt @@ -1,4 +1,4 @@ #title SetImageColorMod [RCBasic Doc] -#header sub SetImageColorMod(slot, c) - +#header sub SetImageColorMod(img_id, c) +Sets the color modulation vlaue for an image diff --git a/doc/files/setlightambientcolor.txt b/doc/files/setlightambientcolor.txt index 8ebec04..ea60d05 100644 --- a/doc/files/setlightambientcolor.txt +++ b/doc/files/setlightambientcolor.txt @@ -1,4 +1,4 @@ #title SetLightAmbientColor [RCBasic Doc] #header sub SetLightAmbientColor( actor, color ) - +Sets the ambient color for a light diff --git a/doc/files/setlightattenuation.txt b/doc/files/setlightattenuation.txt index 2bcba8d..5c1f9ba 100644 --- a/doc/files/setlightattenuation.txt +++ b/doc/files/setlightattenuation.txt @@ -1,4 +1,4 @@ #title SetLightAttenuation [RCBasic Doc] #header sub SetLightAttenuation( actor, l_constant, l_linear, l_quadratic ) - +Sets the light strength fading over distance. Overrident by setting radius. diff --git a/doc/files/setlightdiffusecolor.txt b/doc/files/setlightdiffusecolor.txt index b8dcc53..cf3ab36 100644 --- a/doc/files/setlightdiffusecolor.txt +++ b/doc/files/setlightdiffusecolor.txt @@ -1,4 +1,4 @@ #title SetLightDiffuseColor [RCBasic Doc] #header sub SetLightDiffuseColor( actor, color ) - +Sets a light's diffuse color diff --git a/doc/files/setlightfalloff.txt b/doc/files/setlightfalloff.txt index 0118536..3a1c116 100644 --- a/doc/files/setlightfalloff.txt +++ b/doc/files/setlightfalloff.txt @@ -1,4 +1,6 @@ #title SetLightFalloff [RCBasic Doc] #header sub SetLightFalloff( actor, falloff ) +Sets the strength decrease between the inner and outer cone of a light +Note: Only applies to spot lights diff --git a/doc/files/setlightinnercone.txt b/doc/files/setlightinnercone.txt index 8ac95c8..a00f77e 100644 --- a/doc/files/setlightinnercone.txt +++ b/doc/files/setlightinnercone.txt @@ -1,4 +1,4 @@ #title SetLightInnerCone [RCBasic Doc] #header sub SetLightInnerCone( actor, angle ) - +Sets the inner cone of a spot light diff --git a/doc/files/setlightoutercone.txt b/doc/files/setlightoutercone.txt index 8adb2a4..efbe80c 100644 --- a/doc/files/setlightoutercone.txt +++ b/doc/files/setlightoutercone.txt @@ -1,4 +1,5 @@ #title SetLightOuterCone [RCBasic Doc] #header sub SetLightOuterCone( actor, angle) +Sets the outer cone of a spot light diff --git a/doc/files/setlightshadowcast.txt b/doc/files/setlightshadowcast.txt index 596a0e2..78fc4ab 100644 --- a/doc/files/setlightshadowcast.txt +++ b/doc/files/setlightshadowcast.txt @@ -1,4 +1,6 @@ #title setLightShadowCast [RCBasic Doc] #header sub setLightShadowCast( actor, flag ) +Sets whether a light will cast shadows on actors that have shadows enabled +#ref AddActorShadow diff --git a/doc/files/setmaterialblendfactor.txt b/doc/files/setmaterialblendfactor.txt index eb61c38..78dc552 100644 --- a/doc/files/setmaterialblendfactor.txt +++ b/doc/files/setmaterialblendfactor.txt @@ -1,4 +1,6 @@ #title setMaterialBlendFactor [RCBasic Doc] #header sub setMaterialBlendFactor( material_id, bf) +Sets the blend factor for a material + diff --git a/doc/files/setmaterialcolormask.txt b/doc/files/setmaterialcolormask.txt index 7a496c8..9192bb0 100644 --- a/doc/files/setmaterialcolormask.txt +++ b/doc/files/setmaterialcolormask.txt @@ -1,4 +1,6 @@ #title setMaterialColorMask [RCBasic Doc] #header sub setMaterialColorMask( material_id, color_mask) +Sets a color mask for a material +#ref GetMaterialColorMask diff --git a/doc/files/setmaterialdiffusecolor.txt b/doc/files/setmaterialdiffusecolor.txt index 559876e..fa00546 100644 --- a/doc/files/setmaterialdiffusecolor.txt +++ b/doc/files/setmaterialdiffusecolor.txt @@ -1,4 +1,4 @@ #title setMaterialDiffuseColor [RCBasic Doc] #header sub setMaterialDiffuseColor( material_id, color) - +Set's a material's diffuse color diff --git a/doc/files/setmaterialemissivecolor.txt b/doc/files/setmaterialemissivecolor.txt index 3e4419f..ce348a8 100644 --- a/doc/files/setmaterialemissivecolor.txt +++ b/doc/files/setmaterialemissivecolor.txt @@ -1,4 +1,4 @@ #title setMaterialEmissiveColor [RCBasic Doc] #header sub setMaterialEmissiveColor( material_id, color) - +Set's a material's emissive color diff --git a/doc/files/setmaterialfog.txt b/doc/files/setmaterialfog.txt index b16170d..c829adb 100644 --- a/doc/files/setmaterialfog.txt +++ b/doc/files/setmaterialfog.txt @@ -1,4 +1,4 @@ #title setMaterialFog [RCBasic Doc] #header sub setMaterialFog( material_id, flag) - +Enables or disables fog diff --git a/doc/files/setmaterialfrontfaceculling.txt b/doc/files/setmaterialfrontfaceculling.txt index d14c0dd..b2229bd 100644 --- a/doc/files/setmaterialfrontfaceculling.txt +++ b/doc/files/setmaterialfrontfaceculling.txt @@ -1,4 +1,4 @@ #title setMaterialFrontfaceCulling [RCBasic Doc] -#header sub setMaterialFrontfaceCulling( material_id, flag) - +#header sub setMaterialFrontFaceCulling( material_id, flag) +Enables or disables front face culling diff --git a/doc/files/setmaterialgouraudshading.txt b/doc/files/setmaterialgouraudshading.txt index 3589db8..17d3ccd 100644 --- a/doc/files/setmaterialgouraudshading.txt +++ b/doc/files/setmaterialgouraudshading.txt @@ -1,4 +1,6 @@ #title setMaterialGouraudShading [RCBasic Doc] #header sub setMaterialGouraudShading( material_id, flag) +Sets whether material will use gourad shading or flat shading +True for goraud, False for flat diff --git a/doc/files/setmateriallighting.txt b/doc/files/setmateriallighting.txt index 25b2b24..e5f1fa2 100644 --- a/doc/files/setmateriallighting.txt +++ b/doc/files/setmateriallighting.txt @@ -1,4 +1,4 @@ #title setMaterialLighting [RCBasic Doc] #header sub setMaterialLighting( material_id, flag) - +Sets whether material will be lighted or not diff --git a/doc/files/setmaterialnormalize.txt b/doc/files/setmaterialnormalize.txt index 7ceb8f4..4a76e85 100644 --- a/doc/files/setmaterialnormalize.txt +++ b/doc/files/setmaterialnormalize.txt @@ -1,4 +1,4 @@ #title setMaterialNormalize [RCBasic Doc] #header sub setMaterialNormalize( material_id, flag) - +Sets whether normals should be normalized diff --git a/doc/files/setmaterialpointcloud.txt b/doc/files/setmaterialpointcloud.txt index 28cba47..84cac48 100644 --- a/doc/files/setmaterialpointcloud.txt +++ b/doc/files/setmaterialpointcloud.txt @@ -1,4 +1,4 @@ #title setMaterialPointCloud [RCBasic Doc] #header sub setMaterialPointCloud( material_id, flag) - +Sets whether material is drawn as a point cloud or filled triangles diff --git a/doc/files/setmaterialshininess.txt b/doc/files/setmaterialshininess.txt index 7dcae4e..47266f3 100644 --- a/doc/files/setmaterialshininess.txt +++ b/doc/files/setmaterialshininess.txt @@ -1,4 +1,6 @@ #title setMaterialShininess [RCBasic Doc] #header sub setMaterialShininess( material_id, shininess) +Sets the size of specular highlights +Values range from 0 to 128 diff --git a/doc/files/setmaterialspecularcolor.txt b/doc/files/setmaterialspecularcolor.txt index 791dd76..ee0bb31 100644 --- a/doc/files/setmaterialspecularcolor.txt +++ b/doc/files/setmaterialspecularcolor.txt @@ -1,4 +1,4 @@ #title setMaterialSpecularColor [RCBasic Doc] #header sub setMaterialSpecularColor( material_id, color) - +Sets the specular color of a material diff --git a/doc/files/setmaterialtexture.txt b/doc/files/setmaterialtexture.txt index 67085bd..cff7695 100644 --- a/doc/files/setmaterialtexture.txt +++ b/doc/files/setmaterialtexture.txt @@ -1,4 +1,6 @@ #title setMaterialTexture [RCBasic Doc] #header sub setMaterialTexture( material_id, level, img_id) +Sets the texture on a specified texture level of a material +Note: Generally you want to just set level 0 diff --git a/doc/files/setmaterialtexturecanvas.txt b/doc/files/setmaterialtexturecanvas.txt index ea2817f..8f4424c 100644 --- a/doc/files/setmaterialtexturecanvas.txt +++ b/doc/files/setmaterialtexturecanvas.txt @@ -1,4 +1,5 @@ #title setMaterialTextureCanvas [RCBasic Doc] #header sub setMaterialTextureCanvas( material_id, level, canvas_id) +Sets a material's texture source as a canvas. diff --git a/doc/files/setmaterialthickness.txt b/doc/files/setmaterialthickness.txt index d19cb52..798efab 100644 --- a/doc/files/setmaterialthickness.txt +++ b/doc/files/setmaterialthickness.txt @@ -1,4 +1,4 @@ #title setMaterialThickness [RCBasic Doc] #header sub setMaterialThickness( material_id, thickness) - +Sets the thickness of non 3d elements diff --git a/doc/files/setmaterialwireframe.txt b/doc/files/setmaterialwireframe.txt index e2bf12c..191516f 100644 --- a/doc/files/setmaterialwireframe.txt +++ b/doc/files/setmaterialwireframe.txt @@ -1,4 +1,4 @@ #title setMaterialWireframe [RCBasic Doc] #header sub setMaterialWireframe( material_id, flag) - +Sets whether a material is draw as unfilled triangles or filled triangles diff --git a/doc/files/setmatrixrotation.txt b/doc/files/setmatrixrotation.txt index 907d48a..77bef19 100644 --- a/doc/files/setmatrixrotation.txt +++ b/doc/files/setmatrixrotation.txt @@ -1,4 +1,4 @@ #title SetMatrixRotation [RCBasic Doc] #header sub SetMatrixRotation( mA, x, y, z ) - +Sets the rotation vector of a matrix diff --git a/doc/files/setmatrixscale.txt b/doc/files/setmatrixscale.txt index e362946..07db979 100644 --- a/doc/files/setmatrixscale.txt +++ b/doc/files/setmatrixscale.txt @@ -1,4 +1,4 @@ #title SetMatrixScale [RCBasic Doc] #header sub SetMatrixScale( mA, x, y, z ) - +Sets the scale vector of a matrix diff --git a/doc/files/setmatrixtranslation.txt b/doc/files/setmatrixtranslation.txt index 55c1e8f..c127048 100644 --- a/doc/files/setmatrixtranslation.txt +++ b/doc/files/setmatrixtranslation.txt @@ -1,4 +1,4 @@ #title SetMatrixTranslation [RCBasic Doc] #header sub SetMatrixTranslation( mA, x, y, z ) - +Sets the translation vector of a matrix diff --git a/doc/files/setmatrixvalue.txt b/doc/files/setmatrixvalue.txt index 12bb912..6eb5d4f 100644 --- a/doc/files/setmatrixvalue.txt +++ b/doc/files/setmatrixvalue.txt @@ -1,4 +1,4 @@ #title SetMatrixValue [RCBasic Doc] #header sub SetMatrixValue(mA, r, c, v) - +Sets the value of a cell in a matrix diff --git a/doc/files/setmouserelative.txt b/doc/files/setmouserelative.txt index 5b62174..1638c8b 100644 --- a/doc/files/setmouserelative.txt +++ b/doc/files/setmouserelative.txt @@ -1,4 +1,4 @@ #title SetMouseRelative [RCBasic Doc] #header sub SetMouseRelative(flag) - +Constrains the mouse to the window diff --git a/doc/files/setmousezone.txt b/doc/files/setmousezone.txt index a1c3b94..06ec454 100644 --- a/doc/files/setmousezone.txt +++ b/doc/files/setmousezone.txt @@ -1,4 +1,4 @@ #title SetMouseZone [RCBasic Doc] #header sub SetMouseZone(x, y, w, h) - +Constrains the mouse to a specified area of the window diff --git a/doc/files/setmusicposition.txt b/doc/files/setmusicposition.txt index 7421763..c06dd89 100644 --- a/doc/files/setmusicposition.txt +++ b/doc/files/setmusicposition.txt @@ -1,4 +1,4 @@ #title SetMusicPosition [RCBasic Doc] #header sub SetMusicPosition(pos) - +Sets the position of the loaded music track diff --git a/doc/files/setmusicvolume.txt b/doc/files/setmusicvolume.txt index 65258be..777769e 100644 --- a/doc/files/setmusicvolume.txt +++ b/doc/files/setmusicvolume.txt @@ -1,4 +1,4 @@ #title SetMusicVolume [RCBasic Doc] #header sub SetMusicVolume(vol) - +Sets the volume of the loaded music track diff --git a/doc/files/setsoundchannels.txt b/doc/files/setsoundchannels.txt index 47ed129..9300d13 100644 --- a/doc/files/setsoundchannels.txt +++ b/doc/files/setsoundchannels.txt @@ -1,4 +1,4 @@ #title SetSoundChannels [RCBasic Doc] #header sub SetSoundChannels(max_channels) - +Sets the maximum number of sound channels. diff --git a/doc/files/setsoundvolume.txt b/doc/files/setsoundvolume.txt index 67afee4..fafb922 100644 --- a/doc/files/setsoundvolume.txt +++ b/doc/files/setsoundvolume.txt @@ -1,4 +1,4 @@ #title SetSoundVolume [RCBasic Doc] -#header sub SetSoundVolume(slot, vol) - +#header sub SetSoundVolume(snd, vol) +Sets the volume of a sound diff --git a/doc/files/setspriteposition.txt b/doc/files/setspriteposition.txt index 531db66..1cc16ce 100644 --- a/doc/files/setspriteposition.txt +++ b/doc/files/setspriteposition.txt @@ -1,4 +1,6 @@ #title SetSpritePosition [RCBasic Doc] #header Sub SetSpritePosition( sprite, x, y ) +Sets the position of the sprite in the canvas +Note: This is canvas position and not screen position diff --git a/doc/files/setterraincameramovementdelta.txt b/doc/files/setterraincameramovementdelta.txt index 3a0d362..a58e436 100644 --- a/doc/files/setterraincameramovementdelta.txt +++ b/doc/files/setterraincameramovementdelta.txt @@ -1,4 +1,7 @@ #title SetTerrainCameraMovementDelta [RCBasic Doc] #header sub SetTerrainCameraMovementDelta( actor, delta ) +Sets the movement camera threshold. + +It is used to determine when to recalculate indices for the actor. The default value is 10. diff --git a/doc/files/setterraincamerarotationdelta.txt b/doc/files/setterraincamerarotationdelta.txt index 425b0f3..90bde83 100644 --- a/doc/files/setterraincamerarotationdelta.txt +++ b/doc/files/setterraincamerarotationdelta.txt @@ -1,4 +1,7 @@ #title SetTerrainCameraRotationDelta [RCBasic Doc] #header sub SetTerrainCameraRotationDelta( actor, delta ) +Sets the rotation camera threshold. + +It is used to determine when to recalculate indices for the scene node. The default value is 1. diff --git a/doc/files/setterrainloddistance.txt b/doc/files/setterrainloddistance.txt index f9b6f0d..3dfaadd 100644 --- a/doc/files/setterrainloddistance.txt +++ b/doc/files/setterrainloddistance.txt @@ -1,4 +1,4 @@ #title SetTerrainLODDistance [RCBasic Doc] #header sub SetTerrainLODDistance( actor, LOD, distance ) - +Override the default generation of distance thresholds. diff --git a/doc/files/setterrainpatchlod.txt b/doc/files/setterrainpatchlod.txt index 34d7d8d..f880bfa 100644 --- a/doc/files/setterrainpatchlod.txt +++ b/doc/files/setterrainpatchlod.txt @@ -1,4 +1,4 @@ #title SetTerrainPatchLOD [RCBasic Doc] #header sub SetTerrainPatchLOD( actor, patchX, patchZ, LOD ) - +Manually sets the LOD of a patch. diff --git a/doc/files/setvideodrawrect.txt b/doc/files/setvideodrawrect.txt index b65212c..9c7b6d0 100644 --- a/doc/files/setvideodrawrect.txt +++ b/doc/files/setvideodrawrect.txt @@ -1,4 +1,6 @@ #title SetVideoDrawRect [RCBasic Doc] #header sub SetVideoDrawRect(x, y, w, h) +Sets the area on the current canvas where the video will be displayed. +Note: This is a function that was more useful in older versions of RCBasic. Currently its better to use canvas controls for this. diff --git a/doc/files/setvideoposition.txt b/doc/files/setvideoposition.txt index 590eca2..53d0f61 100644 --- a/doc/files/setvideoposition.txt +++ b/doc/files/setvideoposition.txt @@ -1,4 +1,6 @@ #title SetVideoPosition [RCBasic Doc] #header sub SetVideoPosition(pos) +Sets the position within the current video in milliseconds +#ref GetVideoPosition diff --git a/doc/files/setvideovolume.txt b/doc/files/setvideovolume.txt index 371c675..3615e0d 100644 --- a/doc/files/setvideovolume.txt +++ b/doc/files/setvideovolume.txt @@ -1,4 +1,4 @@ #title SetVideoVolume [RCBasic Doc] #header sub SetVideoVolume( vol ) - +Sets the volume of the video track diff --git a/doc/files/setwindowalwaysontop.txt b/doc/files/setwindowalwaysontop.txt index 9b517ca..444102d 100644 --- a/doc/files/setwindowalwaysontop.txt +++ b/doc/files/setwindowalwaysontop.txt @@ -1,4 +1,4 @@ #title SetWindowAlwaysOnTop [RCBasic Doc] #header sub SetWindowAlwaysOnTop( flag ) - +Sets the window as the highest priority on the display. diff --git a/doc/files/setwindowautoclose.txt b/doc/files/setwindowautoclose.txt index 37a8e5a..56dcf92 100644 --- a/doc/files/setwindowautoclose.txt +++ b/doc/files/setwindowautoclose.txt @@ -1,4 +1,4 @@ #title SetWindowAutoClose [RCBasic Doc] #header sub SetWindowAutoClose( exit_on_close ) - +Sets whether the close button on the window closes it. diff --git a/doc/files/setwindowbordered.txt b/doc/files/setwindowbordered.txt index b3dbd72..d01da10 100644 --- a/doc/files/setwindowbordered.txt +++ b/doc/files/setwindowbordered.txt @@ -1,4 +1,6 @@ #title SetWindowBordered [RCBasic Doc] #header sub SetWindowBordered( flag) +Sets whether the window has a border or not. +#ref WindowIsBordered diff --git a/doc/files/setwindowfullscreen.txt b/doc/files/setwindowfullscreen.txt index bbd3dab..b89ffd2 100644 --- a/doc/files/setwindowfullscreen.txt +++ b/doc/files/setwindowfullscreen.txt @@ -1,4 +1,4 @@ #title SetWindowFullscreen [RCBasic Doc] #header sub SetWindowFullscreen( flag) - +You will never guess what this does diff --git a/doc/files/setwindowicon.txt b/doc/files/setwindowicon.txt index a4fc7a8..12ba367 100644 --- a/doc/files/setwindowicon.txt +++ b/doc/files/setwindowicon.txt @@ -1,4 +1,4 @@ #title SetWindowIcon [RCBasic Doc] -#header sub SetWindowIcon( slot) - +#header sub SetWindowIcon( img ) +Sets the icon that is displayed on the window border diff --git a/doc/files/setwindowmaxsize.txt b/doc/files/setwindowmaxsize.txt index 73e06b8..13f6edc 100644 --- a/doc/files/setwindowmaxsize.txt +++ b/doc/files/setwindowmaxsize.txt @@ -1,4 +1,4 @@ #title SetWindowMaxSize [RCBasic Doc] #header sub SetWindowMaxSize( w, h) - +Sets the max size for a resizable window diff --git a/doc/files/setwindowminsize.txt b/doc/files/setwindowminsize.txt index 5c8c99d..06988b5 100644 --- a/doc/files/setwindowminsize.txt +++ b/doc/files/setwindowminsize.txt @@ -1,4 +1,4 @@ #title SetWindowMinSize [RCBasic Doc] #header sub SetWindowMinSize( w, h) - +Sets the min size for a resizable window diff --git a/doc/files/setwindowposition.txt b/doc/files/setwindowposition.txt index f5499c1..a8ee5f2 100644 --- a/doc/files/setwindowposition.txt +++ b/doc/files/setwindowposition.txt @@ -1,4 +1,4 @@ #title SetWindowPosition [RCBasic Doc] #header sub SetWindowPosition( x, y ) - +Sets the position of the window on the display diff --git a/doc/files/setwindowresizable.txt b/doc/files/setwindowresizable.txt index 9cfd406..cf1f85c 100644 --- a/doc/files/setwindowresizable.txt +++ b/doc/files/setwindowresizable.txt @@ -1,4 +1,4 @@ #title SetWindowResizable [RCBasic Doc] #header sub SetWindowResizable( flag ) - +Sets whether or not a window is resizable diff --git a/doc/files/setwindowsize.txt b/doc/files/setwindowsize.txt index 1ee95af..aae9525 100644 --- a/doc/files/setwindowsize.txt +++ b/doc/files/setwindowsize.txt @@ -1,4 +1,4 @@ #title SetWindowSize [RCBasic Doc] #header sub SetWindowSize( w, h ) - +Sets the size of a window diff --git a/doc/files/setwindowtitle.txt b/doc/files/setwindowtitle.txt index 2850855..78e294c 100644 --- a/doc/files/setwindowtitle.txt +++ b/doc/files/setwindowtitle.txt @@ -1,4 +1,4 @@ #title SetWindowTitle [RCBasic Doc] #header sub SetWindowTitle( title$ ) - +Sets the title of the window diff --git a/doc/files/showmouse.txt b/doc/files/showmouse.txt index cd973b7..fc6c9f2 100644 --- a/doc/files/showmouse.txt +++ b/doc/files/showmouse.txt @@ -1,4 +1,4 @@ #title ShowMouse [RCBasic Doc] #header sub ShowMouse() - +Sets the mouse cursor visible diff --git a/doc/files/showwindow.txt b/doc/files/showwindow.txt index b3e9e05..2e15a70 100644 --- a/doc/files/showwindow.txt +++ b/doc/files/showwindow.txt @@ -1,4 +1,4 @@ #title ShowWindow [RCBasic Doc] #header sub ShowWindow( ) - +Sets the window visible diff --git a/doc/files/sign.txt b/doc/files/sign.txt index 1f955a0..4d9b649 100644 --- a/doc/files/sign.txt +++ b/doc/files/sign.txt @@ -1,4 +1,8 @@ #title Sign [RCBasic Doc] #header function Sign(n) +Returns the sign of a number +n < 0 returns -1 +n = 0 returns 0 +n > 0 returns 1 diff --git a/doc/files/sin.txt b/doc/files/sin.txt index 0957f8a..99fcd02 100644 --- a/doc/files/sin.txt +++ b/doc/files/sin.txt @@ -1,4 +1,4 @@ #title Sin [RCBasic Doc] #header function Sin(n) - +Returns the sine of angle n diff --git a/doc/files/size.txt b/doc/files/size.txt index cbf8089..b4c4518 100644 --- a/doc/files/size.txt +++ b/doc/files/size.txt @@ -1,4 +1,8 @@ #title Size [RCBasic Doc] #header function Size(s$) +Returns the size in bytes of a string +The size will not always be the same as the length. For instance, a lot of unicode characters are represented by more than one byte. + +#ref Len Length diff --git a/doc/files/solvematrix.txt b/doc/files/solvematrix.txt index 633ba20..9b8bd93 100644 --- a/doc/files/solvematrix.txt +++ b/doc/files/solvematrix.txt @@ -1,4 +1,6 @@ #title SolveMatrix [RCBasic Doc] #header function SolveMatrix(mA, mB, mC) +Solve the system that has mA as coefficient and mB as the hand side of the equation. Stores the result in mC. +Returns true if it was able to be solved and false if not. diff --git a/doc/files/soundexists.txt b/doc/files/soundexists.txt index 0a4e2e6..43304d5 100644 --- a/doc/files/soundexists.txt +++ b/doc/files/soundexists.txt @@ -1,4 +1,4 @@ #title SoundExists [RCBasic Doc] -#header function SoundExists(slot) - +#header function SoundExists(snd) +Returns true if the snd id given is associated with an allocated audio track in memory diff --git a/doc/files/soundisenabled.txt b/doc/files/soundisenabled.txt index c5f80c2..d9716eb 100644 --- a/doc/files/soundisenabled.txt +++ b/doc/files/soundisenabled.txt @@ -1,4 +1,4 @@ #title SoundIsEnabled [RCBasic Doc] #header function SoundIsEnabled() - +Returns true if the audio subsystem has been initialized. diff --git a/doc/files/sqrt.txt b/doc/files/sqrt.txt index 66cf612..2665f91 100644 --- a/doc/files/sqrt.txt +++ b/doc/files/sqrt.txt @@ -1,4 +1,4 @@ #title Sqrt [RCBasic Doc] #header function Sqrt(n) - +Returns the square root of n diff --git a/doc/files/squarematrix.txt b/doc/files/squarematrix.txt index 25527e0..7f92595 100644 --- a/doc/files/squarematrix.txt +++ b/doc/files/squarematrix.txt @@ -1,4 +1,4 @@ #title SquareMatrix [RCBasic Doc] #header function SquareMatrix(mA, mB) - +Stores the square of matrix mA in the matrix mB diff --git a/doc/files/stack_size_n.txt b/doc/files/stack_size_n.txt index 80f3c93..834e08b 100644 --- a/doc/files/stack_size_n.txt +++ b/doc/files/stack_size_n.txt @@ -1,4 +1,4 @@ #title Stack_Size_N [RCBasic Doc] #header function Stack_Size_N( num_stack ) - +Returns the number of elements on a number stack diff --git a/doc/files/stack_size_s.txt b/doc/files/stack_size_s.txt index 24ba602..2f4651e 100644 --- a/doc/files/stack_size_s.txt +++ b/doc/files/stack_size_s.txt @@ -1,4 +1,4 @@ #title Stack_Size_S [RCBasic Doc] #header function Stack_Size_S( str_stack ) - +Returns the number of elements on a string stack diff --git a/doc/files/str.txt b/doc/files/str.txt index 84acfb0..340112a 100644 --- a/doc/files/str.txt +++ b/doc/files/str.txt @@ -1,4 +1,4 @@ #title Str$ [RCBasic Doc] #header function Str$(n) - +Returns a number converted to a string diff --git a/doc/files/str_f.txt b/doc/files/str_f.txt index 89e8cfc..2ed2984 100644 --- a/doc/files/str_f.txt +++ b/doc/files/str_f.txt @@ -1,4 +1,8 @@ #title Str_F$ [RCBasic Doc] #header function Str_F$(n) +Returns a number converted to a string in fixed notation +The number will be returned with 6 decimal places of precision. + +#ref Str$ Str_S$ diff --git a/doc/files/str_s.txt b/doc/files/str_s.txt index 7ae7b55..a33ce20 100644 --- a/doc/files/str_s.txt +++ b/doc/files/str_s.txt @@ -1,4 +1,7 @@ #title Str_S$ [RCBasic Doc] #header function Str_S$(n) +Returns a number converted to a string in scientific notation + +#ref Str$ Str_F$ diff --git a/doc/files/stringfill.txt b/doc/files/stringfill.txt index a171ec6..5fc2972 100644 --- a/doc/files/stringfill.txt +++ b/doc/files/stringfill.txt @@ -1,4 +1,4 @@ #title StringFill$ [RCBasic Doc] #header function StringFill$(src$, n) - +Returns a string filled with src$ repeated n times diff --git a/doc/files/stringfrombuffer.txt b/doc/files/stringfrombuffer.txt index 64f13d8..4092010 100644 --- a/doc/files/stringfrombuffer.txt +++ b/doc/files/stringfrombuffer.txt @@ -1,4 +1,4 @@ #title StringFromBuffer$ [RCBasic Doc] #header function StringFromBuffer$(ByRef buffer, buffer_size) - +Returns a string generated from the character values stored in the buffer diff --git a/doc/files/subtractmatrix.txt b/doc/files/subtractmatrix.txt index c614614..ece702d 100644 --- a/doc/files/subtractmatrix.txt +++ b/doc/files/subtractmatrix.txt @@ -1,4 +1,4 @@ #title SubtractMatrix [RCBasic Doc] #header function SubtractMatrix(mA, mB, mC) - +Stores matrix mA minus matrix mB in matrix mC diff --git a/doc/files/swapmatrix.txt b/doc/files/swapmatrix.txt index a73d28b..1a51c51 100644 --- a/doc/files/swapmatrix.txt +++ b/doc/files/swapmatrix.txt @@ -1,4 +1,4 @@ #title SwapMatrix [RCBasic Doc] #header sub SwapMatrix(mA, mB) - +Swaps the contents of 2 matrices diff --git a/doc/files/swapmatrixcolumn.txt b/doc/files/swapmatrixcolumn.txt index 5728a5b..4292fdc 100644 --- a/doc/files/swapmatrixcolumn.txt +++ b/doc/files/swapmatrixcolumn.txt @@ -1,4 +1,4 @@ #title SwapMatrixColumn [RCBasic Doc] #header function SwapMatrixColumn(mA, C1, C2) - +Swaps the contents of 2 columns in a matrix diff --git a/doc/files/swapmatrixrow.txt b/doc/files/swapmatrixrow.txt index 5b907a5..f039a6a 100644 --- a/doc/files/swapmatrixrow.txt +++ b/doc/files/swapmatrixrow.txt @@ -1,4 +1,4 @@ #title SwapMatrixRow [RCBasic Doc] #header function SwapMatrixRow(mA, R1, R2) - +Swaps the contents of 2 rows in a matrix diff --git a/doc/files/system.txt b/doc/files/system.txt index 9c8f9c7..40d03b5 100644 --- a/doc/files/system.txt +++ b/doc/files/system.txt @@ -1,4 +1,4 @@ #title System [RCBasic Doc] #header function System(cmd$) - +Runs an operating system command diff --git a/doc/files/systemram.txt b/doc/files/systemram.txt index 2262af5..d3dbd87 100644 --- a/doc/files/systemram.txt +++ b/doc/files/systemram.txt @@ -1,4 +1,4 @@ #title SystemRam [RCBasic Doc] #header function SystemRam() - +Returns the amount of RAM available diff --git a/doc/files/systemreturnstdout.txt b/doc/files/systemreturnstdout.txt index 44d12c0..6c907da 100644 --- a/doc/files/systemreturnstdout.txt +++ b/doc/files/systemreturnstdout.txt @@ -1,4 +1,6 @@ #title SystemReturnStdOut$ [RCBasic Doc] #header function SystemReturnStdOut$(cmd$) +Runs an operating system command and returns the output +#ref System diff --git a/doc/files/tally.txt b/doc/files/tally.txt index a73ac20..0a4f2b4 100644 --- a/doc/files/tally.txt +++ b/doc/files/tally.txt @@ -1,4 +1,4 @@ #title Tally [RCBasic Doc] #header function Tally(src$, substr$) - +Returns the number of instances of substr$ in the src$ string diff --git a/doc/files/tan.txt b/doc/files/tan.txt index fcd4fff..8228f51 100644 --- a/doc/files/tan.txt +++ b/doc/files/tan.txt @@ -1,4 +1,4 @@ #title Tan [RCBasic Doc] #header function Tan(n) - +Returns the tangent of n diff --git a/doc/files/tcp_acceptsocket.txt b/doc/files/tcp_acceptsocket.txt index eaf6298..ce67aac 100644 --- a/doc/files/tcp_acceptsocket.txt +++ b/doc/files/tcp_acceptsocket.txt @@ -1,4 +1,4 @@ #title TCP_AcceptSocket [RCBasic Doc] #header function TCP_AcceptSocket(server, client) - +Attempts to accept a connection from a server socket. If successful it will open a client socket to communicate with the server and return true. If it fails it will return false. diff --git a/doc/files/tcp_closesocket.txt b/doc/files/tcp_closesocket.txt index 4af1841..7a04842 100644 --- a/doc/files/tcp_closesocket.txt +++ b/doc/files/tcp_closesocket.txt @@ -1,4 +1,4 @@ #title TCP_CloseSocket [RCBasic Doc] #header sub TCP_CloseSocket(socket) - +Closes a socket diff --git a/doc/files/tcp_getdata.txt b/doc/files/tcp_getdata.txt index 6c62b32..2f165e7 100644 --- a/doc/files/tcp_getdata.txt +++ b/doc/files/tcp_getdata.txt @@ -1,4 +1,4 @@ #title TCP_GetData [RCBasic Doc] #header function TCP_GetData(socket, numBytes, ByRef sData$) - +Reads a given number of bytes from a socket diff --git a/doc/files/tcp_opensocket.txt b/doc/files/tcp_opensocket.txt index 3c3d8d7..1d170bf 100644 --- a/doc/files/tcp_opensocket.txt +++ b/doc/files/tcp_opensocket.txt @@ -1,4 +1,4 @@ #title TCP_OpenSocket [RCBasic Doc] #header function TCP_OpenSocket(host$, port) - +Opens a socket to talk to host$ on the given port diff --git a/doc/files/tcp_remotehost.txt b/doc/files/tcp_remotehost.txt index b6b0982..bc1dcdc 100644 --- a/doc/files/tcp_remotehost.txt +++ b/doc/files/tcp_remotehost.txt @@ -1,4 +1,4 @@ #title TCP_RemoteHost [RCBasic Doc] #header function TCP_RemoteHost(socket) - +Returns the destination host address diff --git a/doc/files/tcp_remoteport.txt b/doc/files/tcp_remoteport.txt index dc694db..ed804cc 100644 --- a/doc/files/tcp_remoteport.txt +++ b/doc/files/tcp_remoteport.txt @@ -1,4 +1,4 @@ #title TCP_RemotePort [RCBasic Doc] #header function TCP_RemotePort(socket) - +Returns the port the socket is connecting on diff --git a/doc/files/tcp_senddata.txt b/doc/files/tcp_senddata.txt index b579a59..63b506d 100644 --- a/doc/files/tcp_senddata.txt +++ b/doc/files/tcp_senddata.txt @@ -1,4 +1,4 @@ #title TCP_SendData [RCBasic Doc] #header sub TCP_SendData(socket, sData$) - +Send data through the given socket. diff --git a/doc/files/tcp_socketready.txt b/doc/files/tcp_socketready.txt index 701ea26..2aaef60 100644 --- a/doc/files/tcp_socketready.txt +++ b/doc/files/tcp_socketready.txt @@ -1,4 +1,4 @@ #title TCP_SocketReady [RCBasic Doc] #header function TCP_SocketReady(socket) - +Returns 0 for no activity and non zero for activity. You need to call CheckSockets() at some point before this otherwise it will always return 0. diff --git a/doc/files/tell.txt b/doc/files/tell.txt index 2e8ef31..4184850 100644 --- a/doc/files/tell.txt +++ b/doc/files/tell.txt @@ -1,4 +1,4 @@ #title Tell [RCBasic Doc] #header function Tell(stream) - +Returns the current position within the file stream diff --git a/doc/files/ticks.txt b/doc/files/ticks.txt index 9626703..14825a1 100644 --- a/doc/files/ticks.txt +++ b/doc/files/ticks.txt @@ -1,4 +1,4 @@ #title Ticks [RCBasic Doc] #header function Ticks() - +Returns the number of CPU ticks since the start of a program diff --git a/doc/files/time.txt b/doc/files/time.txt index cef1bb2..574c68b 100644 --- a/doc/files/time.txt +++ b/doc/files/time.txt @@ -1,4 +1,4 @@ #title Time$ [RCBasic Doc] #header function Time$() - +Returns the current time in "HH:MM:SS" format diff --git a/doc/files/timer.txt b/doc/files/timer.txt index 308a725..0f6a398 100644 --- a/doc/files/timer.txt +++ b/doc/files/timer.txt @@ -1,4 +1,4 @@ #title Timer [RCBasic Doc] #header function Timer() - +Returns the number of milliseconds since the start of the program. diff --git a/doc/files/touchpressure.txt b/doc/files/touchpressure.txt index 84902d0..b9c8de0 100644 --- a/doc/files/touchpressure.txt +++ b/doc/files/touchpressure.txt @@ -1,4 +1,4 @@ #title TouchPressure [RCBasic Doc] #header function TouchPressure() - +Returns the touch pressure of a touch event. diff --git a/doc/files/transposematrix.txt b/doc/files/transposematrix.txt index aa8a1c9..eae9039 100644 --- a/doc/files/transposematrix.txt +++ b/doc/files/transposematrix.txt @@ -1,4 +1,4 @@ #title TransposeMatrix [RCBasic Doc] #header function TransposeMatrix(mA, mB) - +Stores the transpose of matrix mA in matrix mB diff --git a/doc/files/trim.txt b/doc/files/trim.txt index d93c949..d2e64a2 100644 --- a/doc/files/trim.txt +++ b/doc/files/trim.txt @@ -1,4 +1,4 @@ #title Trim$ [RCBasic Doc] #header function Trim$(src$) - +Returns src$ with all leading and trailing spaces removed diff --git a/doc/files/ucase.txt b/doc/files/ucase.txt index da32693..081a29c 100644 --- a/doc/files/ucase.txt +++ b/doc/files/ucase.txt @@ -1,4 +1,4 @@ #title Ucase$ [RCBasic Doc] #header function Ucase$(src$) - +Returns src$ with all characters uppercase diff --git a/doc/files/udp_closesocket.txt b/doc/files/udp_closesocket.txt index 12d731b..c8e2d57 100644 --- a/doc/files/udp_closesocket.txt +++ b/doc/files/udp_closesocket.txt @@ -1,4 +1,4 @@ #title UDP_CloseSocket [RCBasic Doc] #header sub UDP_CloseSocket(socket) - +Closes a UDP Socket diff --git a/doc/files/udp_getdata.txt b/doc/files/udp_getdata.txt index 7970b5e..ba4114f 100644 --- a/doc/files/udp_getdata.txt +++ b/doc/files/udp_getdata.txt @@ -1,4 +1,4 @@ #title UDP_GetData [RCBasic Doc] #header function UDP_GetData(socket, byref host$, byref port, byref sData$) - +Reads data from a udp socket. diff --git a/doc/files/udp_length.txt b/doc/files/udp_length.txt index 09b3bc8..a70ef35 100644 --- a/doc/files/udp_length.txt +++ b/doc/files/udp_length.txt @@ -1,4 +1,4 @@ #title UDP_Length [RCBasic Doc] #header function UDP_Length() - +Returns the number of bytes read from a udp socket diff --git a/doc/files/udp_maxlength.txt b/doc/files/udp_maxlength.txt index 7358d01..a9ce7cc 100644 --- a/doc/files/udp_maxlength.txt +++ b/doc/files/udp_maxlength.txt @@ -1,4 +1,4 @@ #title UDP_MaxLength [RCBasic Doc] #header function UDP_MaxLength() - +Returns the maximum number of bytes from a udp socket diff --git a/doc/files/udp_opensocket.txt b/doc/files/udp_opensocket.txt index b355133..65ff894 100644 --- a/doc/files/udp_opensocket.txt +++ b/doc/files/udp_opensocket.txt @@ -1,4 +1,4 @@ #title UDP_OpenSocket [RCBasic Doc] #header function UDP_OpenSocket(port) - +Opens a UDP socket diff --git a/doc/files/udp_remotehost.txt b/doc/files/udp_remotehost.txt index 1a73bbe..a9a0d4e 100644 --- a/doc/files/udp_remotehost.txt +++ b/doc/files/udp_remotehost.txt @@ -1,4 +1,4 @@ #title UDP_RemoteHost$ [RCBasic Doc] #header function UDP_RemoteHost$(socket) - +Returns the connected host in a udp connection diff --git a/doc/files/udp_remoteport.txt b/doc/files/udp_remoteport.txt index c8e7958..fb75eb4 100644 --- a/doc/files/udp_remoteport.txt +++ b/doc/files/udp_remoteport.txt @@ -1,4 +1,4 @@ #title UDP_RemotePort [RCBasic Doc] #header function UDP_RemotePort(socket) - +Returns the port the socket is connected on. diff --git a/doc/files/udp_senddata.txt b/doc/files/udp_senddata.txt index f7a39dd..3db16d7 100644 --- a/doc/files/udp_senddata.txt +++ b/doc/files/udp_senddata.txt @@ -1,4 +1,4 @@ #title UDP_SendData [RCBasic Doc] #header sub UDP_SendData(socket, host$, port, sData$) - +Sends data to a host using UDP diff --git a/doc/files/udp_socketready.txt b/doc/files/udp_socketready.txt index 0f01add..b3b9f2c 100644 --- a/doc/files/udp_socketready.txt +++ b/doc/files/udp_socketready.txt @@ -1,4 +1,13 @@ #title UDP_SocketReady [RCBasic Doc] #header function UDP_SocketReady(socket) +Returns 0 for no activity and non zero for activity. You need to call CheckSockets() at some point before this otherwise it will always +return 0. +#code +If UDP_SocketReady ( 0 ) > 0 Then + 'Socket has activity so we can do something here +End If +#/code + +#ref CheckSockets diff --git a/doc/files/unaugmentmatrix.txt b/doc/files/unaugmentmatrix.txt index 11b526c..d236202 100644 --- a/doc/files/unaugmentmatrix.txt +++ b/doc/files/unaugmentmatrix.txt @@ -1,4 +1,4 @@ #title UnAugmentMatrix [RCBasic Doc] #header function UnAugmentMatrix(mA, mB, mC) - +Splits matrix mA into coefficient mB and augment mC diff --git a/doc/files/update.txt b/doc/files/update.txt index 18fea69..d3d18cd 100644 --- a/doc/files/update.txt +++ b/doc/files/update.txt @@ -1,4 +1,19 @@ #title Update [RCBasic Doc] #header sub Update() +This is the most important function in a graphics window. It must be called every frame. +It performs a few different operations +#list ol +#li Renders all graphics +#li Checks for every event on the window + #list ul + #li Keyboard and Mouse Events + #li Joystick Events + #li Window Control Events (minimize, maximize, close, etc.) + #/list +#li Updates the physics simulation for 2D and 3D objects if enabled +#li Makes breakfast if you are hungry +#/list + +If you have a window open, you should have this function being called in your main render loop every frame. diff --git a/doc/files/val.txt b/doc/files/val.txt index 2251cd0..60150a2 100644 --- a/doc/files/val.txt +++ b/doc/files/val.txt @@ -1,4 +1,6 @@ #title Val [RCBasic Doc] #header function Val(n$) +Converts a string to a number and returns the value. +Returns 0 if the string was not a valid number. diff --git a/doc/files/videoend.txt b/doc/files/videoend.txt index 6029416..420a409 100644 --- a/doc/files/videoend.txt +++ b/doc/files/videoend.txt @@ -1,4 +1,4 @@ #title VideoEnd [RCBasic Doc] #header function VideoEnd() - +Returns true when the currently playing video reaches the end diff --git a/doc/files/videoexists.txt b/doc/files/videoexists.txt index 5b6c802..fbb2228 100644 --- a/doc/files/videoexists.txt +++ b/doc/files/videoexists.txt @@ -1,4 +1,4 @@ #title VideoExists [RCBasic Doc] #header function VideoExists() - +Returns true if there is a video loaded diff --git a/doc/files/videoisplaying.txt b/doc/files/videoisplaying.txt index 72d29e2..d026de5 100644 --- a/doc/files/videoisplaying.txt +++ b/doc/files/videoisplaying.txt @@ -1,4 +1,4 @@ #title VideoIsPlaying [RCBasic Doc] #header function VideoIsPlaying() - +Returns true if a video is playing diff --git a/doc/files/wait.txt b/doc/files/wait.txt index 2c073f3..532cb58 100644 --- a/doc/files/wait.txt +++ b/doc/files/wait.txt @@ -1,4 +1,4 @@ #title Wait [RCBasic Doc] #header sub Wait(m_sec) - +Halts execution of a program for a given number of milliseconds. diff --git a/doc/files/waitkey.txt b/doc/files/waitkey.txt index 6282a2c..b15b2b0 100644 --- a/doc/files/waitkey.txt +++ b/doc/files/waitkey.txt @@ -1,4 +1,4 @@ #title WaitKey [RCBasic Doc] #header function WaitKey() - +Halts execution of a program until a key is pressed. diff --git a/doc/files/warpmouse.txt b/doc/files/warpmouse.txt index ca6eb1c..519730d 100644 --- a/doc/files/warpmouse.txt +++ b/doc/files/warpmouse.txt @@ -1,4 +1,4 @@ #title WarpMouse [RCBasic Doc] #header sub WarpMouse(x, y) - +Move the mouse cursor to xy position in the window diff --git a/doc/files/warpmouseglobal.txt b/doc/files/warpmouseglobal.txt index 6d36e07..bda6283 100644 --- a/doc/files/warpmouseglobal.txt +++ b/doc/files/warpmouseglobal.txt @@ -1,4 +1,4 @@ #title WarpMouseGlobal [RCBasic Doc] #header sub WarpMouseGlobal(x, y) - +Move the mouse cursor to xy position in the display diff --git a/doc/files/windowclip.txt b/doc/files/windowclip.txt index eeebb9c..f79c076 100644 --- a/doc/files/windowclip.txt +++ b/doc/files/windowclip.txt @@ -1,4 +1,6 @@ #title WindowClip [RCBasic Doc] #header function WindowClip(x, y, w, h) +Returns an image with a portion of the window stored +#ref CanvasClip diff --git a/doc/files/windowevent_close.txt b/doc/files/windowevent_close.txt index a4bcc24..88ff136 100644 --- a/doc/files/windowevent_close.txt +++ b/doc/files/windowevent_close.txt @@ -1,4 +1,4 @@ #title WindowEvent_Close [RCBasic Doc] #header function WindowEvent_Close() - +Returns true if the window close event is called. diff --git a/doc/files/windowevent_maximize.txt b/doc/files/windowevent_maximize.txt index 820fd09..b2e32d8 100644 --- a/doc/files/windowevent_maximize.txt +++ b/doc/files/windowevent_maximize.txt @@ -1,4 +1,4 @@ #title WindowEvent_Maximize [RCBasic Doc] #header function WindowEvent_Maximize() - +Returns true if the window maximize event is called. diff --git a/doc/files/windowevent_minimize.txt b/doc/files/windowevent_minimize.txt index a32de19..5f0b87d 100644 --- a/doc/files/windowevent_minimize.txt +++ b/doc/files/windowevent_minimize.txt @@ -1,4 +1,4 @@ #title WindowEvent_Minimize [RCBasic Doc] #header function WindowEvent_Minimize() - +Returns true if the window minimize event is called. diff --git a/doc/files/windowevent_resize.txt b/doc/files/windowevent_resize.txt index 9f733ed..60b7d8e 100644 --- a/doc/files/windowevent_resize.txt +++ b/doc/files/windowevent_resize.txt @@ -1,4 +1,4 @@ #title WindowEvent_Resize [RCBasic Doc] #header function WindowEvent_Resize() - +Returns true if the window resize event is called. diff --git a/doc/files/windowexists.txt b/doc/files/windowexists.txt index c6ac2a5..a08fac4 100644 --- a/doc/files/windowexists.txt +++ b/doc/files/windowexists.txt @@ -1,4 +1,4 @@ #title WindowExists [RCBasic Doc] #header function WindowExists() - +Returns true if the window is open diff --git a/doc/files/windowhasinputfocus.txt b/doc/files/windowhasinputfocus.txt index 4930a60..e4c2c8e 100644 --- a/doc/files/windowhasinputfocus.txt +++ b/doc/files/windowhasinputfocus.txt @@ -1,4 +1,4 @@ #title WindowHasInputFocus [RCBasic Doc] #header function WindowHasInputFocus() - +Returns true if the window has input focus, otherwise it returns false. diff --git a/doc/files/windowhasmousefocus.txt b/doc/files/windowhasmousefocus.txt index c366a23..36c9c87 100644 --- a/doc/files/windowhasmousefocus.txt +++ b/doc/files/windowhasmousefocus.txt @@ -1,4 +1,4 @@ #title WindowHasMouseFocus [RCBasic Doc] #header function WindowHasMouseFocus() - +Returns true if the window has mouse focus, otherwise it returns false. diff --git a/doc/files/windowisbordered.txt b/doc/files/windowisbordered.txt index 17cf5ad..f22c130 100644 --- a/doc/files/windowisbordered.txt +++ b/doc/files/windowisbordered.txt @@ -1,4 +1,4 @@ #title WindowIsBordered [RCBasic Doc] #header function WindowIsBordered() - +Returns true if the window has a border, otherwise it will return false. diff --git a/doc/files/windowisfullscreen.txt b/doc/files/windowisfullscreen.txt index 54d4af9..84a5aa2 100644 --- a/doc/files/windowisfullscreen.txt +++ b/doc/files/windowisfullscreen.txt @@ -1,4 +1,4 @@ #title WindowIsFullscreen [RCBasic Doc] #header function WindowIsFullscreen() - +Returns true if the window is fullscreen, otherwise it will return false. diff --git a/doc/files/windowisgrabbed.txt b/doc/files/windowisgrabbed.txt index d883040..0aee396 100644 --- a/doc/files/windowisgrabbed.txt +++ b/doc/files/windowisgrabbed.txt @@ -1,4 +1,4 @@ #title WindowIsGrabbed [RCBasic Doc] #header function WindowIsGrabbed( ) - +Returns the window that is currently grabbing input. It returns -1 on failure. diff --git a/doc/files/windowismaximized.txt b/doc/files/windowismaximized.txt index 8e22594..a7a9900 100644 --- a/doc/files/windowismaximized.txt +++ b/doc/files/windowismaximized.txt @@ -1,4 +1,4 @@ #title WindowIsMaximized [RCBasic Doc] #header function WindowIsMaximized() - +Returns true if the window is maximized, otherwise it will return false. diff --git a/doc/files/windowisminimized.txt b/doc/files/windowisminimized.txt index 38cca84..96e20a4 100644 --- a/doc/files/windowisminimized.txt +++ b/doc/files/windowisminimized.txt @@ -1,4 +1,4 @@ #title WindowIsMinimized [RCBasic Doc] #header function WindowIsMinimized() - +Returns true if the window is minimized, otherwise it will return false. diff --git a/doc/files/windowisresizable.txt b/doc/files/windowisresizable.txt index 08b0b04..14e51a7 100644 --- a/doc/files/windowisresizable.txt +++ b/doc/files/windowisresizable.txt @@ -1,4 +1,4 @@ #title WindowIsResizable [RCBasic Doc] #header function WindowIsResizable() - +Returns true if the window is resizable, otherwise it will return false. diff --git a/doc/files/windowisvisible.txt b/doc/files/windowisvisible.txt index 990a071..d8c2b9c 100644 --- a/doc/files/windowisvisible.txt +++ b/doc/files/windowisvisible.txt @@ -1,4 +1,4 @@ #title WindowIsVisible [RCBasic Doc] #header function WindowIsVisible() - +Returns true if the window is visible, otherwise it returns false. diff --git a/doc/files/windowmode.txt b/doc/files/windowmode.txt index 5fa5385..d9593d6 100644 --- a/doc/files/windowmode.txt +++ b/doc/files/windowmode.txt @@ -1,4 +1,20 @@ #title WindowMode [RCBasic Doc] #header function WindowMode(visible, fullscreen, resizable, borderless, highDPI) +Returns a bitmask of the combined window flags that can be used in OpenWindow() to set the mode for the window. +Each flag is a boolean that determines whether or not to set that flag in the mask. + +Note: For most use cases, one of the following will work + +Window +#code +mode = WindowMode(1, 0, 0, 0, 0) +#/code +
+Fullscreen +#code +mode = WindowMode(1, 1, 0, 0, 0) +#/code + +#ref OpenWindow GetWindowMode diff --git a/doc/files/windowtitle.txt b/doc/files/windowtitle.txt index ff00fc0..f3627af 100644 --- a/doc/files/windowtitle.txt +++ b/doc/files/windowtitle.txt @@ -1,4 +1,6 @@ #title WindowTitle$ [RCBasic Doc] #header function WindowTitle$( ) +Returns the window title +#ref SetWindowTitle diff --git a/doc/files/write.txt b/doc/files/write.txt index edf82a5..7b5cee5 100644 --- a/doc/files/write.txt +++ b/doc/files/write.txt @@ -1,4 +1,6 @@ #title Write [RCBasic Doc] #header sub Write(stream, txt$) +Writes a string to a file. +#ref WriteLine diff --git a/doc/files/writebyte.txt b/doc/files/writebyte.txt index b017160..493d948 100644 --- a/doc/files/writebyte.txt +++ b/doc/files/writebyte.txt @@ -1,4 +1,6 @@ #title WriteByte [RCBasic Doc] #header sub WriteByte(stream, byte) +Writes a byte to the file. +#ref WriteByteBuffer diff --git a/doc/files/writebytebuffer.txt b/doc/files/writebytebuffer.txt index fe3c08c..add1317 100644 --- a/doc/files/writebytebuffer.txt +++ b/doc/files/writebytebuffer.txt @@ -1,4 +1,4 @@ #title WriteByteBuffer [RCBasic Doc] #header function WriteByteBuffer(stream, ByRef buf, buf_size) - +Writes a number of bytes from a buffer to the file stream.