Difference between revisions of "CopyArray"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Haama
(Created)
 
imported>Haama
(No global flag)
 
(5 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:'''
  (ArrayID:long) CopyArray ArrayID:long ''Size:long''
(ArrayID:long) CopyArray ArrayID:long ''Size:long RefuseZero:short''
(ArrayID:long) DupArray ArrayID:long ''Size:long RefuseZero:short''


Creates a copy of an array and returns the newly created ArrayID.
Creates a copy of an array and returns the newly created ArrayID.
*If Size is not specified, the new array size is the same as the original.
*If Size is not specified, the new array size is the same as the original.
*If Size is specified, the new array will be of the specified size (truncated or expanded).
*If Size is specified, the new array will be of the specified size (truncated or expanded).
*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.
*If the array does not exists, it returns -1.
*If ''RefuseZero'' is 1, then the new Array's ID will never be zero.


==Notes==
==Notes==
*The new array has its EspID set to the calling esp
*The new array has its EspID set to the calling esp


[[Category: Pluggy]]
[[Category: Functions (Pluggy)]]
[[Category: Array Functions (Pluggy)]]

Latest revision as of 12:31, 21 March 2008


A command for Pluggy

Syntax:

(ArrayID:long) CopyArray ArrayID:long Size:long RefuseZero:short
(ArrayID:long) DupArray ArrayID:long Size:long RefuseZero:short

Creates a copy of an array and returns the newly created ArrayID.

  • If Size is not specified, the new array size is the same as the original.
  • If Size is specified, the new array will be of the specified size (truncated or expanded).
  • If the array does not exist, it returns -1.
  • If RefuseZero is 1, then the new Array's ID will never be zero.

Notes[edit | edit source]

  • The new array has its EspID set to the calling esp