Terraria.ModLoader.GlobalEmoteBubble Class Reference

Inheritance diagram for Terraria.ModLoader.GlobalEmoteBubble:

Collaboration diagram for Terraria.ModLoader.GlobalEmoteBubble:

Public Member Functions
override void	SetupContent ()
virtual void	OnSpawn (EmoteBubble emoteBubble)
	Gets called when emote bubbles spawn in world.
virtual bool	UpdateFrame (EmoteBubble emoteBubble)
	Allows you to modify the frame of this emote bubble. Return false to stop vanilla frame update code from running. Returns true by default.
virtual bool	UpdateFrameInEmoteMenu (int emoteType, ref int frameCounter)
	Allows you to modify the frame of this emote bubble which displays in emotes menu. Return false to stop vanilla frame update code from running. Returns true by default. Do note that.
virtual bool	PreDraw (EmoteBubble emoteBubble, SpriteBatch spriteBatch, Texture2D texture, Vector2 position, Rectangle frame, Vector2 origin, SpriteEffects spriteEffects)
	Allows you to draw things behind this emote bubble, or to modify the way this emote bubble is drawn. Return false to stop the game from drawing the emote bubble (useful if you're manually drawing the emote bubble). Returns true by default.
virtual void	PostDraw (EmoteBubble emoteBubble, SpriteBatch spriteBatch, Texture2D texture, Vector2 position, Rectangle frame, Vector2 origin, SpriteEffects spriteEffects)
	Allows you to draw things in front of this emote bubble. This method is called even if PreDraw returns false.
virtual bool	PreDrawInEmoteMenu (int emoteType, SpriteBatch spriteBatch, EmoteButton uiEmoteButton, Vector2 position, Rectangle frame, Vector2 origin)
	Allows you to draw things behind this emote bubble that displays in emotes menu, or to modify the way this emote bubble is drawn. Return false to stop the game from drawing the emote bubble (useful if you're manually drawing the emote bubble). Returns true by default.
virtual void	PostDrawInEmoteMenu (int emoteType, SpriteBatch spriteBatch, EmoteButton uiEmoteButton, Vector2 position, Rectangle frame, Vector2 origin)
	Allows you to draw things in front of this emote bubble. This method is called even if PreDraw returns false.
virtual ? Rectangle	GetFrame (EmoteBubble emoteBubble)
	Allows you to modify the frame rectangle for drawing this emote. Useful for emote bubbles that share the same texture.
virtual ? Rectangle	GetFrameInEmoteMenu (int emoteType, int frame, int frameCounter)
	Allows you to modify the frame rectangle for drawing this emote in emotes menu. Useful for emote bubbles that share the same texture.
virtual bool	AppliesToEntity (TEntity entity, bool lateInstantiation)
	Use this to control whether or not this global should be run on the provided entity instance.
virtual void	SetDefaults (TEntity entity)
	Allows you to set the properties of any and every instance that gets created.
virtual TGlobal	Clone (TEntity? from, TEntity to)
	Create a copy of this instanced global. Called when an entity is cloned.
virtual ? TGlobal	NewInstance (TEntity target)
	Only called if P:Terraria.ModLoader.GlobalType`1.InstancePerEntity and M:Terraria.ModLoader.GlobalType`2.AppliesToEntity(`0,System.Boolean)(target , ...) are both true. Returning null is permitted but not recommended over AppliesToEntity for performance reasons. Only return null when the global is disabled based on some runtime property (eg world seed).
TGlobal	Instance (TEntity entity)

Static Public Member Functions
static TResult	GetGlobal< TResult > (int entityType, ReadOnlySpan< TGlobal > entityGlobals, TResult baseInstance)
static TResult	GetGlobal< TResult > (int entityType, ReadOnlySpan< TGlobal > entityGlobals)
static bool	TryGetGlobal< TResult > (int entityType, ReadOnlySpan< TGlobal > entityGlobals, TResult baseInstance, out TResult result)
static bool	TryGetGlobal< TResult > (int entityType, ReadOnlySpan< TGlobal > entityGlobals, out TResult result)

Protected Member Functions
override void	Register ()
override void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties.

Properties
short	StaticIndex [get, set]
	Index of this global in the list of all globals of the same type, in registration order.
short	PerEntityIndex [get, set]
	Index of this global in a P:Terraria.ModLoader.IEntityWithGlobals`1.EntityGlobals array -1 if this global does not have a P:Terraria.ModLoader.GlobalType`1.SlotPerEntity
virtual bool	SlotPerEntity [get]
	If true, the global will be assigned a P:Terraria.ModLoader.GlobalType`1.PerEntityIndex at load time, which can be used to access the instance in the P:Terraria.ModLoader.IEntityWithGlobals`1.EntityGlobals array. If false, the global will be a singleton applying to all entities.
virtual bool	InstancePerEntity [get]
	Whether to create a new instance of this Global for every entity that exists. Useful for storing information on an entity. Defaults to false. Return true if you need to store information (have non-static fields).
bool	ConditionallyAppliesToEntities [get]
	Whether this global applies to some entities but not others.
override bool	ConditionallyAppliesToEntities [get]
	Whether this global applies to some entities but not others. True if the type overrides M:Terraria.ModLoader.GlobalType`2.AppliesToEntity(`0,System.Boolean)
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.GlobalType`2.Clone(`0,`0) or via the default constructor Defaults to false (default constructor).

Private Attributes
bool?	_isCloneable
bool?	_conditionallyAppliesToEntities

Detailed Description

Definition at line 8 of file GlobalEmoteBubble.cs.

---

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

• source/Terraria.ModLoader/GlobalEmoteBubble.cs