NPCID.Sets.NPCBestiaryDrawModifiers Struct Reference

Stores the draw parameters for an NPC type (NPC.type) in the Bestiary.
Do not use default to create this struct. Use new NPCBestiaryDrawModifiers() instead to set proper default values. More...

Public Member Functions
	NPCBestiaryDrawModifiers ()
	NPCBestiaryDrawModifiers (int seriouslyWhyCantStructsHaveParameterlessConstructors)
	Creates a new NPCBestiaryDrawModifiers with default values. More...

Public Attributes
string	CustomTexturePath
	The path to the custom texture to use when drawing this NPC's Bestiary image. If null, then this NPC's default texture is used. Defaults to null.
int?	Direction
	The specific Entity.direction to use when drawing this NPC's Bestiary image. If null, then -1 is used. Defaults to null.
int?	Frame
	The specific vertical frame to use when drawing this NPC in the Bestiary. If null, then this NPC will play a default walking animation. Defaults to null.
bool	Hide
	If true, this NPC will never show up in the Bestiary. Useful for multi-segment NPCs. Defaults to false.
bool	IsWet
	The specific Entity.wet to use when drawing this NPC's Bestiary image. Useful for NPCs that draw differently when wet. Defaults to false.
float?	PortraitPositionXOverride
	A custom value for Position.X to use when drawing this NPC's Bestiary portrait. If null, then do not override the value. Defaults to null.
float?	PortraitPositionYOverride
	A custom value for Position.Y to use when drawing this NPC's Bestiary portrait. If null, then do not override the value. Defaults to null.
float?	PortraitScale
	A custom value for Scale to use when drawing this NPC's Bestiary portrait. If null, then do not override the value. Defaults to null.
Vector2	Position
	The offset of this NPC's Bestiary image in pixels. Defaults to Vector2.Zero.
float	Rotation
	The clockwise rotation of this NPC's Bestiary image in radians. Defaults to 0f.
float	Scale
	The visual scale of this NPC's Bestiary image. Defaults to 1f.
int?	SpriteDirection
	The specific NPC.spriteDirection to use when drawing this NPC's Bestiary image. If null, then the value of Direction is used. Defaults to null.
float	Velocity
	The magnitude of Entity.velocity.X to use when drawing this NPC's Bestiary image, either when in Portrait mode or when hovered. Defaults to 0f. More...

Detailed Description

Stores the draw parameters for an NPC type (NPC.type) in the Bestiary.
Do not use default to create this struct. Use new NPCBestiaryDrawModifiers() instead to set proper default values.

Constructor & Destructor Documentation

NPCBestiaryDrawModifiers()

NPCID.Sets.NPCBestiaryDrawModifiers.NPCBestiaryDrawModifiers

(

int

seriouslyWhyCantStructsHaveParameterlessConstructors

)

Creates a new NPCBestiaryDrawModifiers with default values.

Parameters

seriouslyWhyCantStructsHaveParameterlessConstructors

Unused.

Member Data Documentation

Velocity

float NPCID.Sets.NPCBestiaryDrawModifiers.Velocity

The magnitude of Entity.velocity.X to use when drawing this NPC's Bestiary image, either when in Portrait mode or when hovered.
Defaults to 0f.

This value is only used if Frame is null.