Maintenance script: Upload from wiki

2020-07-09T13:48:20Z

Upload from wiki

New page

= String List =

The StringList module provides a basic List data structure implementation, in a way which will not leak variables, and is non-volatile when saving (I.e. saved when the game is).

== Downloads ==

''' [http://pastebin.com/EPi29tys Stripped ] (Reccommended) - A compact version with minimal documentation (just section headers).
''' [http://pastebin.com/3H2Wppvd|Full]] - A version with all documentation included in the source file. Assumes use of [[http://wiki.frictionalgames.com/hpl2/resources/improvnotepad Apjjm's Improved Notepad++ HPS Support]

== Installation ==

''' Copy and paste the desired script into your script file.
''' '''OR ''' save the script as an internal file and use an "#include filename.ext" with a [http://wiki.frictionalgames.com/hpl2/resources/preprocess Pre-Processer].
== List Management ==

<syntaxhighlight lang="php">
bool stringListCreate(string &in asName)
</syntaxhighlight>

Creates a stringList with the given name. Returns true if the list was created successfully (no other lists with the same name).

<syntaxhighlight lang="php">
bool stringListDestroy(string &in asName)
</syntaxhighlight>

Destroys the list. Note that there will still be one or two empty string variables left after calling this, so creating multiple lists still leaks. Returns true if the destruction was successful (list existed).

<syntaxhighlight lang="php">
bool stringListExists(string &in asName)
</syntaxhighlight>

Returns true if the named list exists

<syntaxhighlight lang="php">
int stringListSize(string &in asName)
</syntaxhighlight>

Returns the size of the named list (0 if list is empty or does not exist)

<syntaxhighlight lang="php">
void stringListClear(string &in asName)
</syntaxhighlight>

Clears all elements from the list

== Item Management ==

<syntaxhighlight lang="php">
string[] stringListItems(string &in asName)
</syntaxhighlight>

Returns all items in the named list as a string array. Use this if you wish to acess multiple elements in a list without changing the list.

<syntaxhighlight lang="php">
int stringListAddItem(string &in asName, string &in asItem)
</syntaxhighlight>

Adds asItem to the end of the named list. Returns the index of the item added (starting at 0). Returns -1 if the list doesn't exist.

<syntaxhighlight lang="php">
void stringListAddItems(string &in asName, string[] asItems)
</syntaxhighlight>

Adds the collection asItems to the end of named list.

<syntaxhighlight lang="php">
string stringListGetItem(string &in asName, int alIndex)
</syntaxhighlight>

Gets the item at the given index (alIndex) in the named list. For more than one item acess use array access & stringListItems(asName).

<syntaxhighlight lang="php">
int stringListGetLastIndexof(string &in asName, string &in asItem)
</syntaxhighlight>

Gets the index of the last occurance of asItem in the named list. -1 is returned if the item is not in the list (or the list does not exist)

<syntaxhighlight lang="php">
int stringListGetFirstIndexof(string &in asName, string &in asItem)
</syntaxhighlight>

Gets the index of the first occurance of asItem in the named list. -1 is returned if the item is not in the list (or the list does not exist)

<syntaxhighlight lang="php">
bool stringListContains(string &in asName, string &in asItem)
</syntaxhighlight>

Returns true if the list (provided it exists) contains a specific item.

<syntaxhighlight lang="php">
bool stringListRemoveItemAt(string &in asName, uint alIndex)
</syntaxhighlight>

Remove the item at the given index from the specified list. Returns true if an item was removed.

<syntaxhighlight lang="php">
int stringListRemoveItems(string &in asName, string asItem)
</syntaxhighlight>

Removes all items from the given list with the specified name. Returns 0 if no items match or the list does not exist. To remove a single item from the list combine stringListRemoveItemAt and stringListGetFirstIndexof

== Constants ==

You may need to change the constants below if you wish to alter the list delimeter or the prefix of the list variable names.

<syntaxhighlight lang="php">const string _STRLPFX = "_!strli!_"; //Prefixed to all stringList var names - Change this if you get a naming conflict
const string _STRLDLM = "\0"; //SINGLE CHARACTER Delimiter for items in the list. This character may not be used in any item strings.
</syntaxhighlight>

Hpl2:Resources:script modules:stringlist - Revision history

Maintenance script: Upload from wiki