Class CharmUtilities

Contains utility functions related to Charms

Inheritance
object
CharmUtilities
Namespace: WeaverCore.Utilities
Assembly: WeaverCore.dll
Syntax
public static class CharmUtilities

Methods

| Edit this page View Source

CharmDisabled(IWeaverCharm)

Declaration
public static bool CharmDisabled(IWeaverCharm charm)
Parameters
Type Name Description
IWeaverCharm charm
Returns
Type Description
bool
| Edit this page View Source

CharmRegistered(IWeaverCharm)

Declaration
public static bool CharmRegistered(IWeaverCharm charm)
Parameters
Type Name Description
IWeaverCharm charm
Returns
Type Description
bool
| Edit this page View Source

GetCustomCharmID(IWeaverCharm)

Declaration
public static int GetCustomCharmID(IWeaverCharm charm)
Parameters
Type Name Description
IWeaverCharm charm
Returns
Type Description
int
| Edit this page View Source

GetLoadedCharmCount()

Declaration
public static int GetLoadedCharmCount()
Returns
Type Description
int
| Edit this page View Source

GetLoadedCharms()

Declaration
public static IEnumerable<IWeaverCharm> GetLoadedCharms()
Returns
Type Description
IEnumerable<IWeaverCharm>
| Edit this page View Source

GiveCharmToPlayer(int, bool)

Declaration
public static bool GiveCharmToPlayer(int charmID, bool displayCollectMessage = true)
Parameters
Type Name Description
int charmID
bool displayCollectMessage
Returns
Type Description
bool
| Edit this page View Source

GiveCharmToPlayer(IWeaverCharm, bool)

Declaration
public static bool GiveCharmToPlayer(IWeaverCharm charm, bool displayCollectMessage = true)
Parameters
Type Name Description
IWeaverCharm charm
bool displayCollectMessage
Returns
Type Description
bool
| Edit this page View Source

RegisterCharm(IWeaverCharm, Sprite)

Declaration
public static int RegisterCharm(IWeaverCharm charm, Sprite charmSprite)
Parameters
Type Name Description
IWeaverCharm charm

The charm to add
Sprite charmSprite

The sprite of the charm
Returns
Type Description
int

Returns the ID of the registered charm
Exceptions
Type Condition
Exception

Throws if the charm is already registered