Weighted List
A weighted list is an expanded table object allowing for semi-random selection of items from the table based on their preset weighting set when adding the item
| Loaded in Campaign |
|
Example - Creating, Inserting and Extracting:
The following creates a new weighted list, adds some items to it, and then retrieves a semi-random item from the list taking into account the weighting of the objects
local new_list = weighted_list:new();
new_list:add_item("Bob", 5);
new_list:add_item("John", 5);
new_list:add_item("Steve", 10);
local result = new_list:weighted_select();
-- Effective chance of each item being selected: Bob 25%, John 25%, Steve 50%
-
weighted_list:new([tableo]) -
Creates a new weighted list object
Parameters:
1
tableoptional, default value=nil
Pass an object to the new function to use that instance of the object as this new one
Returns:
weighted_listthe new weighted list object
defined in ../working_data/script/_lib/lib_weighted_list.lua, line 35
-
weighted_list:add_item(objectitem, numberweight) -
Allows adding of new items to the weighted list with a set weighting
Parameters:
1
objectThe item to add to the list
2
numberThe weight of this item
Returns:
nil
defined in ../working_data/script/_lib/lib_weighted_list.lua, line 49
-
weighted_list:remove_item(numberi) -
Allows removal of an item from the weighted list
Parameters:
1
numberThe index of the item to remove
Returns:
nil
defined in ../working_data/script/_lib/lib_weighted_list.lua, line 63
-
weighted_list:weighted_select() -
Selects an item from the weighted list with the chance of each item
being selected being their weight relative to all other itemsReturns:
objectthe selected item
defined in ../working_data/script/_lib/lib_weighted_list.lua, line 72
-
weighted_list:random_select() -
Randomly selects an item from the weighted list disregarding any weighting
Returns:
objectthe selected item
defined in ../working_data/script/_lib/lib_weighted_list.lua, line 88