Represents a builder toggle button shown in the top left corner of the screen while the inventory is shown. These toggles typically control wiring-related visiblility or other building-related quality of life features. More...

Inheritance diagram for Terraria.ModLoader.BuilderToggle:

Collaboration diagram for Terraria.ModLoader.BuilderToggle:

Public Member Functions
virtual bool	Active ()
	This dictates whether or not this builder toggle should be active (displayed).

virtual Color	DisplayColorTexture ()
	This is the overlay color that is drawn on top of the texture.

string	DisplayValue ()
	This is the value that will show up when hovering on the toggle icon. You can specify different values per each available P:Terraria.ModLoader.BuilderToggle.CurrentState

override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.

virtual void	Load ()
	Allows you to perform one-time loading tasks. Beware that mod content has not finished loading here, things like ModContent lookup tables or ID Sets are not fully populated.

virtual bool	IsLoadingEnabled (Mod mod)
	Allows you to stop M:Terraria.ModLoader.Mod.AddContent(Terraria.ModLoader.ILoadable) from actually adding this content. Useful for items that can be disabled by a config.

virtual void	SetStaticDefaults ()
	Allows you to modify the properties after initial loading has completed.

virtual void	Unload ()
	Allows you to safely unload things you added in M:Terraria.ModLoader.ModType.Load.

string	PrettyPrintName ()

virtual TModType	Clone (TEntity newEntity)
	Create a copy of this instanced global. Called when an entity is cloned.

virtual TModType	NewInstance (TEntity entity)
	Create a new instance of this ModType for a specific entity.

Protected Member Functions
override void	Register ()

virtual void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.

override void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.

virtual void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties.

TEntity	CreateTemplateEntity ()

Properties
static BuilderToggle	RulerLine = new RulerLineBuilderToggle() `[get, private set]`

static BuilderToggle	RulerGrid = new RulerGridBuilderToggle() `[get, private set]`

static BuilderToggle	AutoActuate = new AutoActuateBuilderToggle() `[get, private set]`

static BuilderToggle	AutoPaint = new AutoPaintBuilderToggle() `[get, private set]`

static BuilderToggle	RedWireVisibility = new RedWireVisibilityBuilderToggle() `[get, private set]`

static BuilderToggle	BlueWireVisibility = new BlueWireVisibilityBuilderToggle() `[get, private set]`

static BuilderToggle	GreenWireVisibility = new GreenWireVisibilityBuilderToggle() `[get, private set]`

static BuilderToggle	YellowWireVisibility = new YellowWireVisibilityBuilderToggle() `[get, private set]`

static BuilderToggle	HideAllWires = new HideAllWiresBuilderToggle() `[get, private set]`

static BuilderToggle	ActuatorsVisibility = new ActuatorsVisibilityBuilderToggle() `[get, private set]`

static BuilderToggle	BlockSwap = new BlockSwapBuilderToggle() `[get, private set]`

static BuilderToggle	TorchBiome = new TorchBiomeBuilderToggle() `[get, private set]`

static string	VanillaHoverTexture `[get]`
	The path to the texture vanilla info displays use when hovering over an info display.

virtual string	HoverTexture `[get]`
	The outline texture drawn when the icon is hovered. By default a circular outline texture is used. Override this method and return `Texture + "_Hover"` or any other texture path to specify a custom outline texture for use with icons that are not circular.

int	Type `[get, set]`
	This is the internal ID of this builder toggle.

virtual string	LocalizationCategory `[get]`
	The category used by this modded content for use in localization keys. Localization keys follow the pattern of "Mods.{ModName}.{Category}.{ContentName}.{DataName}". The Localization wiki pageexplains how custom T:Terraria.ModLoader.ModType classes can utilize this.

virtual int	NumberOfStates = 2 `[get, set]`
	This is the number of different functionalities your builder toggle will have. For a toggle that has an On and Off state, you'd need 2 states!

int	CurrentState `[get]`
	This is the current state of this builder toggle. Every time the toggle is clicked, it will change.

virtual string	Texture `[get]`
	The file name of this type's texture file in the mod loader's file space.

Mod	Mod `[get, set]`
	The mod this belongs to.

virtual string	Name `[get]`
	The internal name of this.

string	FullName `[get]`
	The internal name of this, including the mod it is from.

TEntity	Entity `[get, set]`

virtual bool	IsCloneable `[get]`
	Whether or not this type is cloneable. Cloning is supported if all reference typed fields in each sub-class which doesn't override Clone are marked with [CloneByReference].

virtual bool	CloneNewInstances `[get]`
	Whether to create new instances of this mod type via M:Terraria.ModLoader.ModType`2.Clone(`0) or via the default constructor Defaults to false (default constructor).

Private Member Functions
void ILoadable.	Load (Mod mod)
	Called when loading the type.

Private Attributes
bool?	_isCloneable

Detailed Description

Represents a builder toggle button shown in the top left corner of the screen while the inventory is shown. These toggles typically control wiring-related visiblility or other building-related quality of life features.

The M:Terraria.ModLoader.BuilderToggle.Active property determines if the BuilderToggle should be shown to the user and is usually reliant on player-specific values. The P:Terraria.ModLoader.BuilderToggle.CurrentState property represents the current state of the toggle. For vanilla toggles a value of 0 is off and a value of 1 is on, but modded toggles can have P:Terraria.ModLoader.BuilderToggle.NumberOfStates values.

Definition at line 10 of file BuilderToggle.cs.

The documentation for this class was generated from the following file:

source/Terraria.ModLoader/BuilderToggle.cs

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description