Barotrauma Server
Loading...
Searching...
No Matches
Barotrauma.SpriteSheet Class Reference
Inheritance diagram for Barotrauma.SpriteSheet:
Barotrauma.Sprite

Public Member Functions

 SpriteSheet (ContentXElement element, string path="", string file="")
 
 SpriteSheet (string filePath, int columnCount, int rowCount, Vector2 origin, Rectangle? sourceRect=null)
 
- Public Member Functions inherited from Barotrauma.Sprite
override string ToString ()
 
 Sprite (ContentXElement element, string path="", string file="", bool lazyLoad=false, float sourceRectScale=1)
 
 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.
 
bool ParseTexturePath (string path="", string file="")
 

Properties

int FrameCount [get]
 
Point FrameSize [get]
 
- Properties inherited from Barotrauma.Sprite
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!
 
bool LazyLoad [get]
 
Rectangle SourceRect [get, set]
 
float Depth [get, set]
 
Vector2 Origin [get, set]
 In pixels.
 
Vector2 RelativeOrigin [get, set]
 0 - 1
 
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.
 
string Name [get, set]
 

Additional Inherited Members

- Static Public Member Functions inherited from Barotrauma.Sprite
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 :)
 
- Public Attributes inherited from Barotrauma.Sprite
Vector2 size = Vector2.One
 
float rotation
 
- Protected Attributes inherited from Barotrauma.Sprite
Vector2 offset
 
Vector2 origin
 
float depth
 
- Package Functions inherited from Barotrauma.Sprite

Constructor & Destructor Documentation

◆ SpriteSheet() [1/2]

Barotrauma.SpriteSheet.SpriteSheet ( ContentXElement element,
string path = "",
string file = "" )

◆ SpriteSheet() [2/2]

Barotrauma.SpriteSheet.SpriteSheet ( string filePath,
int columnCount,
int rowCount,
Vector2 origin,
Rectangle? sourceRect = null )

Property Documentation

◆ FrameCount

int Barotrauma.SpriteSheet.FrameCount
get

◆ FrameSize

Point Barotrauma.SpriteSheet.FrameSize
get

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