Applied docspak188.

2014-12-08 12:43:20 +13:00
parent ff8bad7a2d
commit bb0f822db3
649 changed files with 33093 additions and 23947 deletions
@@ -1,27 +1,77 @@
-<html><head><title>Command: Dim </title><meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'><link rel='stylesheet' href='../css/commands.css' type='text/css'></head><body><span class='Command'>&nbsp;&nbsp;Dim variable(elements)&nbsp;&nbsp;</span></p><span class='header'>Definition:</span> <br><br><table width='100%' border='0' cellspacing='2' cellpadding='2' align='center'><tr><td>Dimensions an array variable for storage.</td></tr></table><span class='header'><br>Parameter Description:</span> <br><br><table width='100%' border='0' cellspacing='2' cellpadding='2' align='center'><tr><td>variable = variable of desired type (string, floating, integer)<br>
-elements = number of elements to be created.  Can be multi-dimensional.</td></tr></table><p class='header'>Command Description: <br><br><table width='100%' border='0' cellspacing='2' cellpadding='2' align='center'><tr><td>Prepares an array using the specified variable type as its type and specified elements for the number of containers it should hold.  You may use as many dimension elements as you like (just watch your memory).  There is no way in Blitz to 'Redimension' arrays, so define them accordingly.  Use the proper notation on the declaration variable to make it a string($), floating(#), or integer type array. Note: Arrays always start at ZERO reference - so variable(0) is always the first element.<br>
+<html>
+<head>
+<title>Blitz3D Docs</title>
+<link rel=stylesheet href=../css/commands.css type=text/css>
+</head>
+<body>
+<h1>Dim array_name(index1[,index2][,index3][,...])</h1>
+<h1>Parameters</h1>
+<table>
+<tr>
+<td>
+array_name - array name
+<br />
+index1 - index number of last variable to be created within that particular  index-range
+<br />
+index2 (optional) - index number of last variable to be created within that  particular index-range
+<br />
+index3 (optional) - index number of last variable to be created within that  particular index-range
+<br />
+... (optional) - and so on
+</td>
+</tr>
+</table>
+<h1>Description</h1>
+<table>
+<tr>
+<td>
+Creates an array of the specified type. For example, Dim tiles(10) creates  an integer array, Dim tiles#(10) creates a float array and Dim tile$(10) creates  a string array.
+<br />
+
+<br />
+
+<br />
+The contents of an array can be accessed using the index notation:  0 - indexn, giving indexn+1 number of elements for that particular index range. You should not attempt to access a non-existent element of the array.  In debug mode this will cause an error stating 'index out of bounds'.  With debug off however, you may get 'illegal memory access' errors, or worse no immediate errors at all. 
+<br />
+
+<br />
+Arrays are global, and must be defined in the main program. 
+<br />
+
+<br />
+Arrays can be re-dimmed by using the Dim statement again with the same array  name, but the contents of the array will be lost.
+<br />
+
+<br />
+-----------------------------------------------------------
+<br />
+
+<br />
 *NEW* BLITZ ARRAYS *NEW*
-To use this command effectively, you must understand arrays.  Think of an array like a variable that has multiple slots to hold many values, all under the same variable name.  Before <a href='TYPE.htm'>TYPE</a>s came around, this was the best way to track repeating elements (say, alien ships) because you can iterate through an array collection easily.<br>
 <br />
-Take for example, you want to track 100 aliens on the screen.  You could have two variables - alienx and alieny.  By making these arrays - alienx() and alieny() and each having 100 elements each, you could easily set or retrieve the first alien's location by using alienx(1), alieny(1).  The next alien's coordinates would be alienx(2), alienx(2) and so on.  This makes it easy to use a <a href='FOR.htm'>FOR</a> ... <a href='NEXT.htm'>NEXT</a> or <a href='EACH.htm'>EACH</a> loop to go through all the elements.<br>
+
+<br />
+Since a recent Blitz update you can now do what are called 'blitz arrays'.  These are very different to a Dim'd array, in the following ways:
+<br />
+
+<br />
+They use square brackets [] instead of the normal round ones ().
+<br />
+
+<br />
+You declare them like you do Local or Global variables, example: Local myArray[10]
+<br />
+
+<br />
+They cannot be multi-dimensional, and cannot be resized.
+<br />
+
+<br />
+They can be stored in Type objects.
+<br />
+
 <br />
-Arrays are also useful for 'multi-dimensional' notation too.  Instead of tracking our 100 aliens in the method mentioned above, you could use a single variable: alien(100,1).  The first element collection are the 100 aliens, the second element is the X and Y location of that alien - the 0 element being the alien's X location, and the 1 element being the alien's Y location.  So to set the position of alien 57 to X=640,Y=480 you could do this:<br>
+They can be passed to functions.
 <br />
-alien(57,0)=640<br>
-alien(57,1)=480<br>
-DrawImage imgAlien,alien(57,0),alien(57,1)<br>
-<br>
-Of course, TYPEs are a much better way of doing this sort of multiple value sort of routine.<br>
-<br>
-Arrays are great for tracking collections of items with a single, common element - but often times TYPEs will prove to be more useful.</td></tr></table><p class='header'>Example: <br><br><table width='100%' border='0' cellspacing='2' cellpadding='2' align='center'><tr><td>; DIM example<br>
-; Create a collection of 100 random numbers<br>
-<br>
-; Declare our array<br>
-Dim nums(100)<br>
-<br>
-; Fill each element with a random number<br>
-For T = 1 to 100<br>
-nums(t) = Rnd(1,100)<br>
-Next<br>
-<br></td></tr></table><p><b><a target="_top" href="../index.htm">Index</a></b></p></body>
+
 <br />