Editing __getArray - FilterMeisterWiki

When saving, enter the following:

           ____   _    _   ####    ######  
          |  _ \ | |  | | ##  ##   #       
 ######   | |_) || |  | |##        #       
   ##     |  _ < | |/\| |##        ####    
   ##     |_| \_\\  /\  /##        #       
   ##             \/  \/  ##  ##   #       
   ##                      ####    ######  
   ##

Visit Preferences to set your user name

= __getArray =

== Syntax ==
{{int __getArray(int nr, int x, int y, int z)}}

== Arguments ==
:'''nr'''
::Number of the array. Values from 0 to 99 are accepted.
:'''x, y, z'''
::x, y, and z coordinates of a cell in the array. If you allocated a one-dimensional array, set y and z to zero. If you allocated a two-dimensional array, set z to zero.

== Return ==
Returns the value that was stored at the specified coordinates in the array. ''Warning: If the specified coordinates lie outside the array, the plugin may crash.''

== Description ==
Reads a value from an array.  This is a fast version of ((getArray)) without any error checking or memory checking.  As it does not do any border checking, it may produce error messages or even crashes if not used properly.

== Example ==
See ((allocArray)) for an example of how to allocate arrays and use the similar ((getArray)) function.

== See Also ==
((__putArray)), ((__fgetArray)), ((allocArray)), ((freeArray)), ((putArray)), ((getArrayDim)), ((copyArray))

Summary of change:
Add document to category: