Array Reference: Difference between revisions

=== Examples ===

; An array of integers

int[]

<br>

; An array of MyObjects

MyObject[]

<br>

== Array Creation ==

=== Examples ===

; Create an array of 20 floats

float[] x = new float[20]

<br>

; Create an array of 5 MyScripts

MyScript[] x = new MyScript[5]

<br>

== Array Length ==

=== Examples ===

; Get the length of our array

int[] myArray = new int[10]

x = myArray.Length ; x will get 10

<br>

; Get the length of an uninitialized array (None)

float[] myArray

x = myArray.Length ; x will get 0

<br>

== Array Elements ==

=== Examples ===

; get the first element in the array

x = myArray[0]

<br>

; get the last element of the array

x = myArray[myArray.Length - 1]

<br>

== Warnings ==

*Only the = assignment operator can be used with an [[Arrays_(Papyrus)|array]] (see [[Operator_Reference#Assignment_Operators|Assignment Operators]]):

  ; Will not compile, as the compiler doesn't know how to handle it.

  myArray[3] += 5

<br>

=== Compiler Issues ===

<br>

*Using complex expressions inside of the index brackets of an integer array can cause unexpected behavior -

;these work fine:

myIntArray[i] = newValue

;this will result in unexpected values being inserted into the array at run time:

myIntArray[i * 5 + 1] = newValue

<br>

*The array Find() function should not be used within an array's index brackets; it can also cause unexpected results -

;this works fine:

i = myArray.Find(none)  ;(find the first blank element)

;this will result in values being inserted into unpredictable indices of the array at run time:

myArray[myArray.Find(none)] = newValue

<br>

== Advanced Usage ==

You can create Arrays larger than 128 elements and variable in size using the helper functions in the [[Utility_Script#SKSE_Global_Functions|Utility script]].

float[] LongArrayOfFloats = Utility.CreateFloatArray(512)

int i = 2048

string[] VariableSizeArrayOfStrings = Utility.CreateStringArray(i)

You can access it like any other array.

Debug.trace(LongArrayOfFloats[250])

SKSE also allows you to resize any array on the fly:

Utility.ResizeStringArray(VariableSizeArrayOfStrings, 64)

=== Large Arrays without SKSE ===

If an array larger than 128 elements is required, a work-around is to use multiple arrays to form one large array. Below is an example of how this can be accomplished for an array that can hold 512 floats:

float[] Array1

float[] Array2

endFunction

<br>

[[Category:Scripting]]

[[Category:Papyrus]]

[[Category:Papyrus Language Reference]]