Background for Skyrim SE
Member of the JMap script
stringfunctionnextKey(intobject, stringpreviousKey="", stringendKey="")NativeGlobal

Description

Documentation Comment

Simplifies iteration over container's contents.
Accepts the @previousKey, returns the next key.
If @previousKey == @endKey the function returns the first key.
The function always returns so-called 'valid' keys (the ones != @endKey).
The function returns @endKey ('invalid' key) only once to signal that iteration has reached its end.
In most cases, if the map doesn't contain an invalid key ("" for JMap, None form-key for JFormMap)
it's ok to omit the @endKey.

Usage:

  string key = JMap.nextKey(map, previousKey="", endKey="")
  while key != ""
    <retrieve values here>
    key = JMap.nextKey(map, key, endKey="")
  endwhile

Parameters

  1. intobject

  2. stringpreviousKey=""

  3. stringendKey=""


Examples

Auto-Generated Example

int myInt__object
string myString__previousKey
string myString__endKey

string returnedValue = JMap.nextKey(myInt__object, myString__previousKey, myString__endKey)
Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.