Class TimbnPluginPotions

Namespace

Timbn.GraveyardKeeperTwo.Core.Framework

Assembly

Timbn.GraveyardKeeperTwo.Core.dll

Adds potions to the game on behalf of a plugin. Each potion becomes a real item, buff, and alchemy formula that brews at the mixer and saves like the game's own, and is removed when the plugin unloads. Reach it through the plugin's Potions property.

public sealed class TimbnPluginPotions

Inheritance

object

TimbnPluginPotions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Add(TimbnPotion)

Adds a potion as an item, buff, alchemy formula, and set of ingredient mixes, with its names and descriptions in the loaded language, and runs its buff hooks while the player has the buff. Registering an id that is already registered replaces it, ending the old copy's buff first.

public IDisposable Add(TimbnPotion potion)

Parameters

potion TimbnPotion

The potion to add. Its runes must not match any other formula, or it is skipped with a warning.

Returns

IDisposable

A handle that removes the potion early when disposed. You don't need to keep it.