GSTownList Class Reference

Creates a list of towns that are currently on the map. More...

#include <script_townlist.hpp>

Inheritance diagram for GSTownList:

Public Member Functions
	GSTownList (function filter_function,...)
	Apply a filter when building the list.
Public Member Functions inherited from GSList
void	AddItem (int item, int value)
	Add a single item to the list.
void	RemoveItem (int item)
	Remove a single item from the list.
void	Clear ()
	Clear the list, making Count() returning 0 and IsEmpty() returning true.
bool	HasItem (int item)
	Check if an item is in the list.
int	Begin ()
	Go to the beginning of the list and return the item.
int	Next ()
	Go to the next item in the list and return the item.
bool	IsEmpty ()
	Check if a list is empty.
bool	IsEnd ()
	Check if there is a element left.
int	Count ()
	Returns the amount of items in the list.
int	GetValue (int item)
	Get the value that belongs to this item.
bool	SetValue (int item, int value)
	Set a value of an item directly.
void	Sort (SorterType sorter, bool ascending)
	Sort this list by the given sorter and direction.
void	AddList (GSList *list)
	Add one list to another one.
void	SwapList (GSList *list)
	Swap the contents of two lists.
void	RemoveAboveValue (int value)
	Removes all items with a higher value than 'value'.
void	RemoveBelowValue (int value)
	Removes all items with a lower value than 'value'.
void	RemoveBetweenValue (int start, int end)
	Removes all items with a value above start and below end.
void	RemoveValue (int value)
	Remove all items with this value.
void	RemoveTop (int count)
	Remove the first count items.
void	RemoveBottom (int count)
	Remove the last count items.
void	RemoveList (GSList *list)
	Remove everything that is in the given list from this list (same item index that is).
void	KeepAboveValue (int value)
	Keep all items with a higher value than 'value'.
void	KeepBelowValue (int value)
	Keep all items with a lower value than 'value'.
void	KeepBetweenValue (int start, int end)
	Keep all items with a value above start and below end.
void	KeepValue (int value)
	Keep all items with this value.
void	KeepTop (int count)
	Keep the first count items, i.e.
void	KeepBottom (int count)
	Keep the last count items, i.e.
void	KeepList (GSList *list)
	Keeps everything that is in the given list from this list (same item index that is).
void	Valuate (function valuator_function,...)
	Give all items a value defined by the valuator you give.

Additional Inherited Members
Public Types inherited from GSList
enum	SorterType {   SORT_BY_VALUE ,   SORT_BY_ITEM }
	Type of sorter. More...
Static Public Attributes inherited from GSList
static const bool	SORT_ASCENDING = true
	Sort ascending.
static const bool	SORT_DESCENDING = false
	Sort descending.

Detailed Description

Creates a list of towns that are currently on the map.

Constructor & Destructor Documentation

GSTownList()

GSTownList::GSTownList	(	function	filter_function,
			...
	)

Apply a filter when building the list.

Parameters

filter_function	The function which will be doing the filtering.
...	The params to give to the filters (minus the first param, which is always the index-value).

Note

You can write your own filters and use them. Just remember that the first parameter should be the index-value, and it should return a bool.

Example:

local bribeable_towns = GSTownList(GSTown.IsActionAvailable, GSTown.TOWN_ACTION_BRIBE);
 
function MinPopulation(town_id, pop)
{
  return GSTown.GetPopulation(town_id) >= pop;
}
local proper_towns = GSTownList(MinPopulation, 1000);