SlashCo Wiki

Home / SlashCo.SelectSpawns

SlashCo.SelectSpawns

 Entity or table, number SlashCo.SelectSpawns( table elements, number amount, function conditionsForced = SlashCo.DefaultConditionsForced, function conditionsNonForced = SlashCo.DefaultConditionsNonForced, boolean forceTable = false )

Description

Selects a number of spawns from a sequential table, prioritizing forced spawn entities.
Forced entries are selected first, followed by non-forced entries if additional selections are required.

Arguments

1table elements

Sequential table of spawn entities

2number amount

Number of entries to select. If unspecified, one entry is selected.

3function conditionsForced = SlashCo.DefaultConditionsForced

Optional condition function for forced entries

4function conditionsNonForced = SlashCo.DefaultConditionsNonForced

Optional condition function for non-forced entries

5boolean forceTable = false

If true, returns the selected entries as a table even when selecting one entry

Returns

1Entity or table entries

Selected entity or table of selected entities

2number missed

Number of requested entries that could not be selected when applicable