Flummi/amxmodx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

cellarray: Update lying ArrayCreate doc

Browse Source
This commit is contained in:
Valentin Grünbacher 2014-08-07 21:17:45 +02:00
parent 88b69ea8a1
commit bbffcbf739
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
plugins/include/cellarray.inc
View File

@ -1,12 +1,12 @@
// vim: set ts=4 sw=4 tw=99 noet: // vim: set ts=4 sw=4 tw=99 noet:
// //
// AMX Mod X, based on AMX Mod by Aleksander Naszko ("OLO"). // AMX Mod X, based on AMX Mod by Aleksander Naszko ("OLO").
// Copyright (C) The AMX Mod X Development Team. // Copyright (C) The AMX Mod X Development Team.
// //
// This software is licensed under the GNU General Public License, version 3 or higher. // This software is licensed under the GNU General Public License, version 3 or higher.
// Additional exceptions apply. For full license details, see LICENSE.txt or visit: // Additional exceptions apply. For full license details, see LICENSE.txt or visit:
// https://alliedmods.net/amxmodx-license // https://alliedmods.net/amxmodx-license
#if defined _cellarray_included #if defined _cellarray_included
#endinput #endinput
#endif #endif
@ -53,15 +53,19 @@ stock ByteCountToCells(size)
* *
* @note It is very important that the provided cellsize matches up with the * @note It is very important that the provided cellsize matches up with the
* buffer sizes that you pass with subsequent Array[Get|Set|Push] calls. * buffer sizes that you pass with subsequent Array[Get|Set|Push] calls.
* @note Initially the "reserved" parameter was intended to create blank entries
* that would immediately be usable with Array[Get|Set] functions. This
* functionality was never working as intended, and can now be achieved
* using ArrayResize().
* *
* @param cellsize Size of each array entry in cells * @param cellsize Size of each array entry in cells
* @param reserver Amount of blank entries that are inserted immediately * @param reserved Pre-allocates space in the array for the specified
* upon creation of the array. These are not readable until * number of items. The items are not valid to read or set
* initialized with an ArraySet* function. * until they have actually been pushed into the array.
* *
* @return Handle to the array. * @return Handle to the array.
*/ */
native Array:ArrayCreate(cellsize = 1, reserved = 0); native Array:ArrayCreate(cellsize = 1, reserved = 32);
/** /**
* Clones an array, returning a new handle with the same size and data. * Clones an array, returning a new handle with the same size and data.