Inheritance diagram for Barotrauma.Sprite:

Public Member Functions
override string	ToString ()

	Sprite (ContentXElement element, string path="", string file="", bool lazyLoad=false)

	Sprite (string newFile, Vector2 newOrigin)

	Sprite (string newFile, Rectangle? sourceRectangle, Vector2? origin=null, float rotation=0)

void	Remove ()

void	ReloadXML ()
	Works only if there is a name attribute defined for the sprite. For items and structures, the entity id or name is used if the sprite's name attribute is not defined. More...

bool	ParseTexturePath (string path="", string file="")

	Sprite (Sprite other)

	Sprite (Texture2D texture, Rectangle? sourceRectangle, Vector2? newOffset, float newRotation=0.0f, string path=null)

async Task	LazyLoadAsync ()

void	EnsureLazyLoaded (bool isAsync=false)

void	ReloadTexture ()

void	Draw (ISpriteBatch spriteBatch, Vector2 pos, float rotate=0.0f, float scale=1.0f, SpriteEffects spriteEffect=SpriteEffects.None)

void	Draw (ISpriteBatch spriteBatch, Vector2 pos, Color color, float rotate=0.0f, float scale=1.0f, SpriteEffects spriteEffect=SpriteEffects.None, float? depth=null)

void	Draw (ISpriteBatch spriteBatch, Vector2 pos, Color color, Vector2 origin, float rotate=0.0f, float scale=1.0f, SpriteEffects spriteEffect=SpriteEffects.None, float? depth=null)

virtual void	Draw (ISpriteBatch spriteBatch, Vector2 pos, Color color, Vector2 origin, float rotate, Vector2 scale, SpriteEffects spriteEffect=SpriteEffects.None, float? depth=null)

void	DrawSilhouette (SpriteBatch spriteBatch, Vector2 pos, Vector2 origin, float rotate, Vector2 scale, SpriteEffects spriteEffect=SpriteEffects.None, float? depth=null)
	Creates a silhouette for the sprite (or outline if the sprite is rendered on top of it) More...

void	DrawTiled (ISpriteBatch spriteBatch, Vector2 position, Vector2 targetSize, float rotation=0f, Vector2? origin=null, Color? color=null, Vector2? startOffset=null, Vector2? textureScale=null, float? depth=null, SpriteEffects? spriteEffects=null)

Static Public Member Functions
static Identifier	GetIdentifier (XElement sourceElement)
	Creates a supposedly unique identifier from the parent element. If the parent element is not found, uses the sprite element. TODO: If there are multiple elements with exactly the same data, the ids will fail. -> Is there a better way to identify the sprites? ALSO TODO: delete :) More...

static Texture2D	LoadTexture (string file, bool compress=true, ContentPackage contentPackage=null)

Public Attributes
Vector2	size = Vector2.One

float	rotation

SpriteEffects	effects = SpriteEffects.None

Static Public Attributes
static readonly Version	LastBrokenTiledSpriteGameVersion = new Version(major: 1, minor: 2, build: 7, revision: 0)
	Last version of the game that had broken handling of sprites that were scaled, flipped and offset More...

Protected Attributes
Vector2	offset

Vector2	origin

float	depth

volatile bool	loadingAsync = false

Properties
ContentXElement	SourceElement `[get]`
	Reference to the xml element from where the sprite was created. Can be null if the sprite was not defined in xml! More...

bool	LazyLoad `[get]`

Rectangle	SourceRect `[get, set]`

float	Depth `[get, set]`

Vector2	Origin `[get, set]`
	In pixels More...

Vector2	RelativeOrigin `[get, set]`
	0 - 1 More...

Vector2	RelativeSize `[get]`

ContentPath	FilePath `[get]`

string	FullPath `[get]`

bool	Compress `[get]`

Identifier	EntityIdentifier `[get, set]`
	Identifier of the Map Entity so that we can link the sprite to its owner. More...

string	Name `[get, set]`

Identifier	Identifier `[get]`

static IEnumerable< Sprite >	LoadedSprites `[get]`

Texture2D	texture `[get]`

Texture2D	Texture `[get]`

bool	Loaded `[get]`

Detailed Description

Definition at line 13 of file BarotraumaShared/SharedSource/Sprite/Sprite.cs.

Constructor & Destructor Documentation

◆ Sprite() [1/5]

Barotrauma.Sprite.Sprite	(	ContentXElement	element,
		string	path = `""`,
		string	file = `""`,
		bool	lazyLoad = `false`
	)

Definition at line 110 of file BarotraumaShared/SharedSource/Sprite/Sprite.cs.

◆ Sprite() [2/5]

Barotrauma.Sprite.Sprite	(	string	newFile,
		Vector2	newOrigin
	)

Definition at line 165 of file BarotraumaShared/SharedSource/Sprite/Sprite.cs.

◆ Sprite() [3/5]

Barotrauma.Sprite.Sprite	(	string	newFile,
		Rectangle?	sourceRectangle,
		Vector2?	origin = `null`,
		float	rotation = `0`
	)

Definition at line 171 of file BarotraumaShared/SharedSource/Sprite/Sprite.cs.

◆ Sprite() [4/5]

Barotrauma.Sprite.Sprite ( Sprite other )

Definition at line 81 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ Sprite() [5/5]

Barotrauma.Sprite.Sprite	(	Texture2D	texture,
		Rectangle?	sourceRectangle,
		Vector2?	newOffset,
		float	newRotation = `0.0f`,
		string	path = `null`
	)

Definition at line 88 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

Member Function Documentation

◆ Draw() [1/4]

void Barotrauma.Sprite.Draw	(	ISpriteBatch	spriteBatch,
		Vector2	pos,
		Color	color,
		float	rotate = `0.0f`,
		float	scale = `1.0f`,
		SpriteEffects	spriteEffect = `SpriteEffects.None`,
		float?	depth = `null`
	)

Definition at line 255 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ Draw() [2/4]

virtual void Barotrauma.Sprite.Draw	(	ISpriteBatch	spriteBatch,
		Vector2	pos,
		Color	color,
		Vector2	origin,
		float	rotate,
		Vector2	scale,
		SpriteEffects	spriteEffect = `SpriteEffects.None`,
		float?	depth = `null`
	)

virtual

Reimplemented in Barotrauma.SpriteSheet.

Definition at line 265 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ Draw() [3/4]

void Barotrauma.Sprite.Draw	(	ISpriteBatch	spriteBatch,
		Vector2	pos,
		Color	color,
		Vector2	origin,
		float	rotate = `0.0f`,
		float	scale = `1.0f`,
		SpriteEffects	spriteEffect = `SpriteEffects.None`,
		float?	depth = `null`
	)

Definition at line 260 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ Draw() [4/4]

void Barotrauma.Sprite.Draw	(	ISpriteBatch	spriteBatch,
		Vector2	pos,
		float	rotate = `0.0f`,
		float	scale = `1.0f`,
		SpriteEffects	spriteEffect = `SpriteEffects.None`
	)

Definition at line 250 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ DrawSilhouette()

void Barotrauma.Sprite.DrawSilhouette	(	SpriteBatch	spriteBatch,
		Vector2	pos,
		Vector2	origin,
		float	rotate,
		Vector2	scale,
		SpriteEffects	spriteEffect = `SpriteEffects.None`,
		float?	depth = `null`
	)

Creates a silhouette for the sprite (or outline if the sprite is rendered on top of it)

Definition at line 275 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ DrawTiled()

void Barotrauma.Sprite.DrawTiled	(	ISpriteBatch	spriteBatch,
		Vector2	position,
		Vector2	targetSize,
		float	rotation = `0f`,
		Vector2?	origin = `null`,
		Color?	color = `null`,
		Vector2?	startOffset = `null`,
		Vector2?	textureScale = `null`,
		float?	depth = `null`,
		SpriteEffects?	spriteEffects = `null`
	)

Definition at line 292 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ EnsureLazyLoaded()

void Barotrauma.Sprite.EnsureLazyLoaded ( bool isAsync = false )

Definition at line 133 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ GetIdentifier()

static Identifier Barotrauma.Sprite.GetIdentifier ( XElement sourceElement )

static

Creates a supposedly unique identifier from the parent element. If the parent element is not found, uses the sprite element. TODO: If there are multiple elements with exactly the same data, the ids will fail. -> Is there a better way to identify the sprites? ALSO TODO: delete :)

Definition at line 206 of file BarotraumaShared/SharedSource/Sprite/Sprite.cs.

◆ LazyLoadAsync()

async Task Barotrauma.Sprite.LazyLoadAsync ( )

Definition at line 126 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ LoadTexture()

static Texture2D Barotrauma.Sprite.LoadTexture	(	string	file,
		bool	compress = `true`,
		ContentPackage	contentPackage = `null`
	)

static

Definition at line 198 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ ParseTexturePath()

bool Barotrauma.Sprite.ParseTexturePath	(	string	path = `""`,
		string	file = `""`
	)

Definition at line 291 of file BarotraumaShared/SharedSource/Sprite/Sprite.cs.

◆ ReloadTexture()

void Barotrauma.Sprite.ReloadTexture ( )

Definition at line 169 of file BarotraumaClient/ClientSource/Sprite/Sprite.cs.

◆ ReloadXML()

void Barotrauma.Sprite.ReloadXML ( )

Works only if there is a name attribute defined for the sprite. For items and structures, the entity id or name is used if the sprite's name attribute is not defined.

Definition at line 231 of file BarotraumaShared/SharedSource/Sprite/Sprite.cs.