Terraria.ModLoader.ModMount Class Reference

This class serves as a place for you to place all your properties and hooks for each mount. Create instances of ModMoundData (preferably overriding this class) to pass as parameters to Mod.AddMount. Only one instance of ModMount will exist for each mount, so storing player specific data on the ModMount is not good. Modders can use player.mount._mountSpecificData or a ModPlayer class to store player specific data relating to a mount. Use SetMount to assign these fields. More...

Inheritance diagram for Terraria.ModLoader.ModMount:

Collaboration diagram for Terraria.ModLoader.ModMount:

Public Member Functions
override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.
override ModMount	NewInstance (Mount.MountData entity)
override void	SetStaticDefaults ()
	Allows you to modify the properties after initial loading has completed. This is where you would set properties of this type of mount.
virtual void	JumpHeight (Player mountedPlayer, ref int jumpHeight, float xVelocity)
	Allows you to modify the mount's jump height based on its state.
virtual void	JumpSpeed (Player mountedPlayer, ref float jumpSeed, float xVelocity)
	Allows you to modify the mount's jump speed based on its state.
virtual void	UpdateEffects (Player player)
	Allows you to make things happen when mount is used (creating dust etc.) Can also be used for mount special abilities.
virtual bool	UpdateFrame (Player mountedPlayer, int state, Vector2 velocity)
	Allows for manual updating of mount frame. Return false to stop the default frame behavior. Returns true by default.
virtual void	UseAbility (Player player, Vector2 mousePosition, bool toggleOn)
	Allows you to make things happen while the mouse is pressed while the mount is active. Called each tick the mouse is pressed.
virtual void	AimAbility (Player player, Vector2 mousePosition)
	Allows you to make things happen when the mount ability is aiming (while charging).
virtual void	SetMount (Player player, ref bool skipDust)
	Allows you to make things happen when this mount is spawned in. Useful for player-specific initialization, utilizing player.mount._mountSpecificData or a ModPlayer class since ModMount is shared between all players. Custom dust spawning logic is also possible via the skipDust parameter.
virtual void	Dismount (Player player, ref bool skipDust)
	Allows you to make things happen when this mount is de-spawned. Useful for player-specific cleanup, see SetMount. Custom dust spawning logic is also possible via the skipDust parameter.
virtual bool	Draw (List< DrawData > playerDrawData, int drawType, Player drawPlayer, ref Texture2D texture, ref Texture2D glowTexture, ref Vector2 drawPosition, ref Rectangle frame, ref Color drawColor, ref Color glowColor, ref float rotation, ref SpriteEffects spriteEffects, ref Vector2 drawOrigin, ref float drawScale, float shadow)
	Allows for complete customization of mount drawing. This method will be called once for each supported mount texture layer that exists. Use drawType to conditionally apply changes. drawType corresponds to the following: 0: backTexture, 1: backTextureExtra, 2: frontTexture. 3: frontTextureExtra Corresponding glow textures, such as backTextureGlow, are paired with their corresponding texture and passed into this method as well. Return false if you are manually adding DrawData to playerDrawData to replace the vanilla draw behavior, otherwise tweak ref variables to customize the drawing and add additional DrawData to playerDrawData.
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	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 Mount.MountData	CreateTemplateEntity ()
override void	Register ()
virtual string	GetExtraTexture (MountTextureType textureType)
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.

Package Functions
virtual bool	CustomBodyFrame ()

Properties
Mount.MountData	MountData [get]
	The vanilla MountData object that is controlled by this ModMount.
int	Type [get, set]
	The index of this ModMount in the Mount.mounts array.
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

This class serves as a place for you to place all your properties and hooks for each mount. Create instances of ModMoundData (preferably overriding this class) to pass as parameters to Mod.AddMount. Only one instance of ModMount will exist for each mount, so storing player specific data on the ModMount is not good. Modders can use player.mount._mountSpecificData or a ModPlayer class to store player specific data relating to a mount. Use SetMount to assign these fields.

Definition at line 16 of file ModMount.cs.

---

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

• source/Terraria.ModLoader/ModMount.cs