Difference between revisions of "ArraySize"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Haama
(Created)
 
imported>Quetzilla
m
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__


{{Beta}}
A command for [[:Category:Pluggy|Pluggy]]
A command for [[:Category:Pluggy|Pluggy]]


'''Syntax:'''
'''Syntax:'''
  (Size:long) ArraySize ArrayID:long ''Size:long'' 'Global:short''
  (Size:long) ArraySize ArrayID:long ''Size:long'' ''Global:short''


Returns or sets the Size of the array.
Returns or sets the Size of the array.
Line 11: Line 10:
*If Size is specified, it sets the Size of the array.
*If Size is specified, it sets the Size of the array.
**If you want to modify an array from another mod, you will need to set the Global flag to 1. If Global is 0 or unset the function will fail. If the array is protected the function will fail.
**If you want to modify an array from another mod, you will need to set the Global flag to 1. If Global is 0 or unset the function will fail. If the array is protected the function will fail.
*If the array does not exists, it returns -1.
*If the array does not exist, it returns -1.


[[Category: Pluggy]]
==Notes==
*To effectively clear out an array without destroying and recreating, set the size to 0.
ArraySize ArrayID 0
 
[[Category: Functions (Pluggy)]]
[[Category: Array Functions (Pluggy)]]

Latest revision as of 17:29, 29 May 2008


A command for Pluggy

Syntax:

(Size:long) ArraySize ArrayID:long Size:long Global:short

Returns or sets the Size of the array.

  • If Size is not specified, it returns the current Size.
  • If Size is specified, it sets the Size of the array.
    • If you want to modify an array from another mod, you will need to set the Global flag to 1. If Global is 0 or unset the function will fail. If the array is protected the function will fail.
  • If the array does not exist, it returns -1.

Notes[edit | edit source]

  • To effectively clear out an array without destroying and recreating, set the size to 0.
ArraySize ArrayID 0