Class TimbnPotion

Namespace

Timbn.GraveyardKeeperTwo.Core.Framework

Assembly

Timbn.GraveyardKeeperTwo.Core.dll

Describes a potion for a plugin's Potions.Add. The potion becomes a real item, buff, and alchemy formula, and its buff decides what drinking it does.

public sealed class TimbnPotion

Inheritance

object

TimbnPotion

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Buff

What drinking the potion does.

public TimbnPotionBuff Buff { get; set; }

Property Value

TimbnPotionBuff

BuffId

The id of the buff drinking it gives, the potion's Id with _buff on the end.

public string BuffId { get; }

Property Value

string

Description

The item's description in its tooltip, such as what drinking it does.

public string Description { get; set; }

Property Value

string

HiddenAtStart

Whether the formula starts hidden, so the player has to discover it. Shown from the start by default.

public bool HiddenAtStart { get; set; }

Property Value

bool

IconId

Item icon sprite name. Any sprite the game has, or one added with the plugin's Sprites.AddPng. Empty keeps the template's.

public string IconId { get; set; }

Property Value

string

Id

The potion's item id, such as my_mod_swift_potion. Keep it stable, since saves keep the item under it.

public string Id { get; set; }

Property Value

string

Name

The item's name as the player sees it, such as Swift Potion.

public string Name { get; set; }

Property Value

string

Price

The item's base price in the game's raw units, where 100 is one silver coin. 100 by default.

public int Price { get; set; }

Property Value

int

Runes

Red, green, and blue rune counts of the formula. They must not match any other formula.

public Vector3Int Runes { get; set; }

Property Value

Vector3Int

Tab

The tab of the alchemy formula window the formula lists under. Epic by default.

public AlchemyFormulaTab Tab { get; set; }

Property Value

AlchemyFormulaTab

TemplateItemId

Id of the existing usable item the new one is copied from.

public string TemplateItemId { get; set; }

Property Value

string