Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.ShopItem Class Reference

An item in a shop with details about pricing, etc. More...

Public Attributes

string typeId
 The type of the item. More...
 
int priceOverride = -1
 If not -1 this indicates the price the shop sells the item for. If its -1 the default will be used. More...
 
int sellAmount = 1
 The number of items sold at one time. More...
 
bool shopBuysItem
 Does the shop buy the item. More...
 
int buyPriceOverride = -1
 What price does the shop pay for the item. If -1 then the buy price is the price multiplied by the shops buy price. More...
 
int defaultStock
 The default stock for the given item used when the player first enters store. More...
 
int maxStock = -1
 Controls how many items can be generated and also maximum buy limits. Use -1 for no limits. More...
 
RestockType restockType = RestockType.USE_DEFAULT
 Additional information on top of the shops restock policy to cater for special cases like items that never restock. More...
 
int rarity = 1
 The larger the number the rarer it is to sotck the item. 1 = 1 in 1, 10 = 1 in 10, and so on. Only used if RestockType = USE_RARITY. More...
 

Detailed Description

An item in a shop with details about pricing, etc.

Member Data Documentation

◆ buyPriceOverride

int PlatformerPro.ShopItem.buyPriceOverride = -1

What price does the shop pay for the item. If -1 then the buy price is the price multiplied by the shops buy price.

◆ defaultStock

int PlatformerPro.ShopItem.defaultStock

The default stock for the given item used when the player first enters store.

◆ maxStock

int PlatformerPro.ShopItem.maxStock = -1

Controls how many items can be generated and also maximum buy limits. Use -1 for no limits.

◆ priceOverride

int PlatformerPro.ShopItem.priceOverride = -1

If not -1 this indicates the price the shop sells the item for. If its -1 the default will be used.

◆ rarity

int PlatformerPro.ShopItem.rarity = 1

The larger the number the rarer it is to sotck the item. 1 = 1 in 1, 10 = 1 in 10, and so on. Only used if RestockType = USE_RARITY.

◆ restockType

RestockType PlatformerPro.ShopItem.restockType = RestockType.USE_DEFAULT

Additional information on top of the shops restock policy to cater for special cases like items that never restock.

◆ sellAmount

int PlatformerPro.ShopItem.sellAmount = 1

The number of items sold at one time.

◆ shopBuysItem

bool PlatformerPro.ShopItem.shopBuysItem

Does the shop buy the item.

◆ typeId

string PlatformerPro.ShopItem.typeId

The type of the item.


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