BTD_Mod_Helper​.Api​.Legends​.ModArtifact

BloonsTD6 Mod Helper

BTD_Mod_Helper.Api.Legends

ModArtifact Class

Class for adding a custom Artifact to the Rogue Legends mode

public abstract class ModArtifact : BTD_Mod_Helper.Api.NamedModContent

Inheritance System.Object  ModContent  NamedModContent  ModArtifact

Derived
↳ ModArtifact<TData,TModel>

Fields

ModArtifact.Common Field

Tier for Common Artifacts

protected const int Common = 0;

Field Value

System.Int32

ModArtifact.Legendary Field

Tier for Legendary Artifacts

protected const int Legendary = 2;

Field Value

System.Int32

ModArtifact.Rare Field

Tier for Rare Artifacts

protected const int Rare = 1;

Field Value

System.Int32

Properties

ModArtifact.DescriptionCommon Property

Description for the Common tier of this Artifact

public virtual string DescriptionCommon { get; }

Property Value

System.String

ModArtifact.DescriptionLegendary Property

Description for the Legendary tier of this Artifact

public virtual string DescriptionLegendary { get; }

Property Value

System.String

ModArtifact.DescriptionRare Property

Description for the Rare tier of this Artifact

public virtual string DescriptionRare { get; }

Property Value

System.String

ModArtifact.DisplayNameCommon Property

Displayed Name for the Common tier of this Artifact

public virtual string DisplayNameCommon { get; }

Property Value

System.String

ModArtifact.DisplayNameLegendary Property

Displayed Name for the Legendary tier of this Artifact

public virtual string DisplayNameLegendary { get; }

Property Value

System.String

ModArtifact.DisplayNameRare Property

Displayed Name for the Rare tier of this Artifact

public virtual string DisplayNameRare { get; }

Property Value

System.String

ModArtifact.Icon Property

The Icon for this Artifact, either a VanillaSprites constant or custom texture name

public virtual string Icon { get; }

Property Value

System.String

ModArtifact.IconCommon Property

The Icon for this Artifact, either a VanillaSprites constant or custom texture name

public virtual string IconCommon { get; }

Property Value

System.String

ModArtifact.IconCommonReference Property

The Icon SpriteReference for this Artifact

public virtual SpriteReference IconCommonReference { get; }

Property Value

Il2CppNinjaKiwi.Common.ResourceUtils.SpriteReference

ModArtifact.IconLegendary Property

The Icon for this Artifact, either a VanillaSprites constant or custom texture name

public virtual string IconLegendary { get; }

Property Value

System.String

ModArtifact.IconLegendaryReference Property

The Icon SpriteReference for this Artifact

public virtual SpriteReference IconLegendaryReference { get; }

Property Value

Il2CppNinjaKiwi.Common.ResourceUtils.SpriteReference

ModArtifact.IconRare Property

The Icon for this Artifact, either a VanillaSprites constant or custom texture name

public virtual string IconRare { get; }

Property Value

System.String

ModArtifact.IconRareReference Property

The Icon SpriteReference for this Artifact

public virtual SpriteReference IconRareReference { get; }

Property Value

Il2CppNinjaKiwi.Common.ResourceUtils.SpriteReference

ModArtifact.IconReference Property

The Icon SpriteReference for this Artifact

public virtual SpriteReference IconReference { get; }

Property Value

Il2CppNinjaKiwi.Common.ResourceUtils.SpriteReference

ModArtifact.MaxTier Property

Highest tier this artifact can be at

public virtual int MaxTier { get; }

Property Value

System.Int32

ModArtifact.MinTier Property

Lowest tier this artifact can be at

public virtual int MinTier { get; }

Property Value

System.Int32

ModArtifact.RarityFrameType Property

The tower set themed rarity frame for the artifact

public virtual TowerSet RarityFrameType { get; }

Property Value

Il2CppAssets.Scripts.Models.TowerSets.TowerSet

ModArtifact.SmallIcon Property

Makes the icon for this artifact smaller to mimic the negative space found on dedicated artifact icons

public virtual bool SmallIcon { get; }

Property Value

System.Boolean

ModArtifact.Tiers Property

The tiers this artifact has

public System.Collections.Generic.IEnumerable<(int tier,int index)> Tiers { get; }

Property Value

System.Collections.Generic.IEnumerable<<System.Int32,System.Int32>>

Methods

ModArtifact.Description(int) Method

Artifact's description for a given tier

public virtual string Description(int tier);

Parameters

tier System.Int32

0 for Common, 1 for Rare, 2 for Legendary

Returns

System.String
Displayed description

ModArtifact.GetIcon(int) Method

Gets the icon for a given tier of this artifact

public SpriteReference GetIcon(int tier);

Parameters

tier System.Int32

0, 1, or 2

Returns

Il2CppNinjaKiwi.Common.ResourceUtils.SpriteReference
icon reference

ModArtifact.GetId(int) Method

Gets the id this should use for the given index

public virtual string GetId(int index);

Parameters

index System.Int32

1, 2 or 3

Returns

System.String
The ID to use

ModArtifact.ModifyGameModel(GameModel, int) Method

Modifies the game model for a match where this artifact is active at the given tier

public virtual void ModifyGameModel(GameModel gameModel, int tier);

Parameters

gameModel Il2CppAssets.Scripts.Models.GameModel

new game model

tier System.Int32

artifact tier

ModArtifact.OnActivated(Simulation, int) Method

Triggers when this artifact is activated within the simulation for the given tier


NOTE: Should be robust against potentially being activated again within the same simulation

public virtual void OnActivated(Simulation simulation, int tier);

Parameters

simulation Il2CppAssets.Scripts.Simulation.Simulation

current Sim

tier System.Int32

artifact tier