Terraria.ModLoader.FlipperJump Class Reference

Inheritance diagram for Terraria.ModLoader.FlipperJump:

Collaboration diagram for Terraria.ModLoader.FlipperJump:

Public Member Functions
override float	GetDurationMultiplier (Player player)
override bool	CanStart (Player player)
	An extra condition for whether this extra jump can be started. Used by vanilla for flippers (F:Terraria.Entity.wet). Returns true by default.
override void	OnStarted (Player player, ref bool playSound)
	This hook runs when the player uses this jump via pressing the jump key Effects that should appear when the jump starts can be spawned here. For example, the Cloud in a Bottle's initial puff of smoke is spawned here. To make the jump re-usable, set P:Terraria.DataStructures.ExtraJumpState.Available to true
override Position	GetDefaultPosition ()
override IEnumerable< Position >	GetModdedConstraints ()
	Modded jumps are placed between vanilla jumps via M:Terraria.ModLoader.ExtraJump.GetDefaultPosition and, by default, are sorted in load order. This hook allows you to sort this jump before/after other modded jumps that were placed between the same two vanilla jumps. Example:
override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.
override string	ToString ()
virtual void	ShowVisuals (Player player)
	Spawn effects that should appear while the player is performing this jump here. Only runs while the jump is P:Terraria.DataStructures.ExtraJumpState.Active For example, the Sandstorm in a Bottle's dusts are spawned here.
virtual bool	CanShowVisuals (Player player)
	Return false to prevent M:Terraria.ModLoader.ExtraJump.ShowVisuals(Terraria.Player) from executing. By default, this hook returns whether the player is moving upwards with respect to F:Terraria.Player.gravDir
virtual void	OnEnded (Player player)
	This hook runs before P:Terraria.DataStructures.ExtraJumpState.Active is set from true to false Jumps end when their duration expires or when P:Terraria.DataStructures.ExtraJumpState.Enabled is no longer true. Jumps may end early via M:Terraria.Player.StopExtraJumpInProgress, called when a grappling hook is thrown, the player grabs onto a rope, or when the player is frozen, turned to stone or webbed.
virtual void	UpdateHorizontalSpeeds (Player player)
	Modify the player's horizontal movement while performing this jump here. Only runs while the jump is P:Terraria.DataStructures.ExtraJumpState.Active Vanilla's jumps use the following values:
virtual void	OnRefreshed (Player player)
	This hook runs before P:Terraria.DataStructures.ExtraJumpState.Available is set to true in M:Terraria.Player.RefreshDoubleJumps This occurs at the start of the grounded jump and while the player is grounded, or when jumping off a grappling hook/rope.
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 ()

Static Protected Attributes
static readonly Position	BeforeMountJumps = new Before(BasiliskMount)
static readonly Position	MountJumpPosition = new After(BasiliskMount)
static readonly Position	BeforeBottleJumps = new Before(SandstormInABottle)
static readonly Position	AfterBottleJumps = new After(CloudInABottle)

Properties
static ExtraJump	Flipper = new FlipperJump() [get, private set]
static ExtraJump	BasiliskMount = new BasiliskMountJump() [get, private set]
static ExtraJump	GoatMount = new GoatMountJump() [get, private set]
static ExtraJump	SantankMount = new SantankMountJump() [get, private set]
static ExtraJump	UnicornMount = new UnicornMountJump() [get, private set]
static ExtraJump	SandstormInABottle = new SandstormInABottleJump() [get, private set]
static ExtraJump	BlizzardInABottle = new BlizzardInABottleJump() [get, private set]
static ExtraJump	FartInAJar = new FartInAJarJump() [get, private set]
static ExtraJump	TsunamiInABottle = new TsunamiInABottleJump() [get, private set]
static ExtraJump	CloudInABottle = new CloudInABottleJump() [get, private set]
int	Type [get, set]
	The internal ID of this T:Terraria.ModLoader.ExtraJump.
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

Definition at line 3 of file FlipperJump.cs.

---

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

• source/Terraria.ModLoader/FlipperJump.cs