Script PriceTagComponents

Components

priceTag Indicates the purchase price of the associated sale entity
priceTagCostCurrency Requires a certain amount of currency to purchase an entity
priceTagCostHealth Requires a certain amount of health to purchase an entity
priceTagDepthMultiplier Multiply the tag’s cost by (2 + depth / 2) on spawn
priceTagIgnoreMultiplier
priceTagInvertMultiplier
priceTagMultiplyCostOnPurchase
priceTagShopkeeperProximity Causes a sale entity to become temporarily free when the associated shopkeeper leaves the shop or dies
priceTagShopliftable
priceTagUnlockItem
sale Associates an entity with a purchase price that must be paid before it can be picked up or activated
saleRemoveOnCollect Deletes the associated price tag when the sale entity is picked up
saleRemoveOnDespawn Deletes the associated price tag when the sale entity is despawned
secretShopkeeper
shopkeeper Marks an entity as a shopkeeper, dropping all associated price tags when leaving its home or dying
shoplifter
transactionCheckItemBan
transactionDeleteItem
transactionErrorSound
transactionFlyaway
transactionSellItem
transactionSound
transactionSpawnItem
transactionTeleportClient
trapTransaction


Components

priceTag
Indicates the purchase price of the associated sale entity
  • active bool The current effective purchasability of the entity (default true)
priceTagCostCurrency
Requires a certain amount of currency to purchase an entity
  • currency constant string The currency with which the entity can be purchased (default currency.Type.GOLD)
  • cost int The current purchase cost of the entity, which is the base cost multiplied with a level-specific factor (default 0)
priceTagCostHealth
Requires a certain amount of health to purchase an entity
  • cost int The amount of health drained when purchasing the entity (default 0)
  • type constant int The type of damage dealt by this price tag upon purchase (default damage.Type.BLOOD)
  • killerName constant localizedString Text to display in the run summary screen's "Killed by" entry (default "Blood Debt")
priceTagDepthMultiplier
Multiply the tag’s cost by (2 + depth / 2) on spawn
priceTagIgnoreMultiplier
priceTagInvertMultiplier
priceTagMultiplyCostOnPurchase
  • multiplier constant int (default 2)
priceTagShopkeeperProximity
Causes a sale entity to become temporarily free when the associated shopkeeper leaves the shop or dies
  • default constant bool The value priceTag.active is set to when there’s no associated shopkeeper (default true)
  • shopkeeper entityID The associated shopkeeper (default 0)
priceTagShopliftable
  • allowFurtherPurchases constant bool (default false)
priceTagUnlockItem
sale
Associates an entity with a purchase price that must be paid before it can be picked up or activated
  • priceTag entityID Link to the price tag entity. If not present, the entity is free (default 0)
saleRemoveOnCollect
Deletes the associated price tag when the sale entity is picked up
saleRemoveOnDespawn
Deletes the associated price tag when the sale entity is despawned
secretShopkeeper
  • type constant string (default "")
  • tileX constant int (default 0)
  • tileY constant int (default 0)
  • price int (default 0)
shopkeeper
Marks an entity as a shopkeeper, dropping all associated price tags when leaving its home or dying
shoplifter

default:

{}
  • stolenShopkeepers table
transactionCheckItemBan
  • banMask constant int (default 0)
  • errorFlyaway constant string (default "")
transactionDeleteItem
  • errorFlyaway constant string (default "You have no item in that slot!")
transactionErrorSound
  • sound constant string (default "error")
transactionFlyaway
  • text constant string (default "Success!")
transactionSellItem
  • errorFlyaway constant string (default "I won't buy that!")
transactionSound
  • sound constant string (default "")
transactionSpawnItem
  • chanceType constant string (default "secret")
  • levelBonus constant int (default 0)
  • errorFlyaway constant string (default "")
transactionTeleportClient
trapTransaction
  • slot constant string (default "")
  • shopkeeper entityID (default 0)
  • targetX int (default 0)
  • targetY int (default 0)
generated by LDoc 1.4.6