VSLib Developer Guide - Random Item Spawning

This guide describes how to use the Random Item Spawning feature in VSLib. 

The feature gives you the ability to randomly spawn items at set spawnpoints at any time in your mutation or mod.

Class reference: https://l4d2scripters.github.io/vslib/docs/db/d2b/class_v_s_lib_1_1_random_item_spawner.html

Usage

To initialize a spawner create a spawner object:
VSLib.RandomItemSpawner(spawnArray, itemArray = null, flags = 0)

Arguments:

spawnArray: An array of vectors or VSLib entity objects for the location spawn points.

itemArray: An array of spawnable items (see Spawn Lists for more information).

itemList: Use a custom item list of the same format as the one below.

flags:
RANDOM_USEPARTICLES: Spawns a fireworks particle effect where an item spawns.
RANDOM_ALLOWMULTIPLEITEMS: Can spawn multiple items on the same spawnpoint during a single call of SpawnRandomItems().


Example:
mySpawner <- VSLib.RandomItemSpawner(mySpawnArray, myItemArray, (RANDOM_USEPARTICLES | RANDOM_ALLOWMULTIPLEITEMS));


Items are spawned with: SpawnRandomItems(amount)
Where amount is the number of items spawned. The function returns an array with the entity objects of the items spawned.

Example:
spawnedItemArray = mySpawner.SpawnRandomItems(5);

Spawn Lists

This list determines what items can spawn, and the probability of each weapon spawning. If no list is specified, the default one below is used.

The item probability is relative to the other items, the actual spawning probability is the items probability divided by the probabilities of all items added together.

Melee weapons and upgrades get converted to other entities when they spawn. They are untrackable, and will not be returned by the spawning function.

ent: Classname of the item. The spawn list currently supports the entities specified below.
prob: This is the probability for the item to spawn.
ammo: The ammo reserves primary weapons spawn with. Weapons spawn with double the value set. Set to null on other items.
melee_type: Works the same way as on a weapon_melee_spawn. Set to null if not a melee weapon.