Sprite

The sprite component contains all of the necessary properities for the sprite of an entity. A spirte has a width, height, layer, start_x, start_y, texture_name and UV values.

Properties:

Property	Type	Functionality
width	float	width of the sprite in pixels
height	float	height of the sprite in pixels
layer	int	the layer of the sprite determines when it gets rendered. A lower layer will be rendered first.
start_x	int	determines the start x position for use in a texture atlas. If it is a single texture use 0.
start_y	int	determines the start y position for use in a texture atlas. If it is a single texture use 0.
bHidden	bool	used to hide the texture when we don't want it to be seen.
texture_name	string	the name of the sprite to use. The name MUST exist in the Asset Manager prior to use.
color	Color	The color of the sprite. Defaults to white or Color(255, 255, 255, 255).

Functions:

Function	Description
generate_uvs()	This function will take the width, height of the actual texture, and the start positions to populate the UV values for the texture atlas. UV values are u, v, uv_width, uv_height.

Use Example:

-- Create a new entity
local entity = Entity("tag", "group")

-- Add a new sprite component
local sprite = entity:add_component(
	Sprite(
		"hero_sprite",	-- texture_name
		32,		-- width 
		32,		-- height
		0, 		-- start_x
		0,		-- start_y
		2		-- layer
	)
)

-- After the sprite is created, you have to generate the uvs
sprite:generate_uvs()