SwarmItemManager.PrefabItem Class Reference

This class is used to wrap the prefab so that you can set the maximum count for each item. More...

List of all members.

Public Attributes
GameObject	prefab
	prefab game object of the item
int	maxItemCount = 0
	maximum count for this item (0 = no limit, postive number = the list will be limited to the max item count)
float	inactiveThreshold = 1.0f
	the percentage of total items in the list that triggers the prune timer countdown. if the inactive item count exceeds this percentage, the timer is triggered. (ex: 0.7f = when the inactive item count is greater than 70% of all the items (active and inactive) the prune timer will kick in). defaults to turning on the pruning timer only when every item is inactive.
float	inactivePruneTimer = 0.0f
	the amount of time in seconds to count down after the prune threshold is exceeded. if the inactive count drops below the threshold before this timer has expired, the timer will be shut off and reset. (ex: 5.0f = 5 seconds after the prune threshold is exceeded, the inactive list will be pruned). defaults to pruning immediately when threshold is reached.
float	inactivePrunePercentage = 0.0f
	the percentage to prune the inactive list when the prune timer countdown expires. the amount is the percentage of the inactive list, not the total item count. (ex: 0.3f = approximately one third of the inactive items will be destroyed when the prune timer expires). defaults to no pruning.

---

Detailed Description

This class is used to wrap the prefab so that you can set the maximum count for each item.

---

Member Data Documentation

float SwarmItemManager.PrefabItem.inactivePrunePercentage = 0.0f

the percentage to prune the inactive list when the prune timer countdown expires. the amount is the percentage of the inactive list, not the total item count. (ex: 0.3f = approximately one third of the inactive items will be destroyed when the prune timer expires). defaults to no pruning.

float SwarmItemManager.PrefabItem.inactivePruneTimer = 0.0f

the amount of time in seconds to count down after the prune threshold is exceeded. if the inactive count drops below the threshold before this timer has expired, the timer will be shut off and reset. (ex: 5.0f = 5 seconds after the prune threshold is exceeded, the inactive list will be pruned). defaults to pruning immediately when threshold is reached.

float SwarmItemManager.PrefabItem.inactiveThreshold = 1.0f

the percentage of total items in the list that triggers the prune timer countdown. if the inactive item count exceeds this percentage, the timer is triggered. (ex: 0.7f = when the inactive item count is greater than 70% of all the items (active and inactive) the prune timer will kick in). defaults to turning on the pruning timer only when every item is inactive.

int SwarmItemManager.PrefabItem.maxItemCount = 0

maximum count for this item (0 = no limit, postive number = the list will be limited to the max item count)

GameObject SwarmItemManager.PrefabItem.prefab

prefab game object of the item

---

The documentation for this class was generated from the following file:

• C:/Swarm/SwarmItemManager.cs