font

Documentation

Index

• type Component
• type ComponentFactory
  • func (concrete *ComponentFactory) Add(id akara.EID) *Font
  • func (concrete *ComponentFactory) ExportToLua(state *lua.LState, table *lua.LTable) *lua.LTable
  • func (concrete *ComponentFactory) Get(id akara.EID) (*Font, bool)
• type Font
  • func (component *Font) ExportToLua(state *lua.LState, table *lua.LTable) *lua.LTable
  • func (*Font) New() akara.Component

Types

type Component

type Component = Font // Component is an alias to Font

type ComponentFactory

type ComponentFactory struct {
	*akara.ComponentFactory
}

ComponentFactory is a wrapper for the generic component factory that returns Font component instances. This can be embedded inside of a system to give them the methods for adding, retrieving, and removing a Font.

func (*ComponentFactory) Add

func (concrete *ComponentFactory) Add(id akara.EID) *Font

Add adds a Font component to the given entity and returns it

func (*ComponentFactory) ExportToLua

func (concrete *ComponentFactory) ExportToLua(state *lua.LState, table *lua.LTable) *lua.LTable

func (*ComponentFactory) Get

func (concrete *ComponentFactory) Get(id akara.EID) (*Font, bool)

Get returns the Font component for the given entity, and a bool for whether or not it exists

type Font

type Font struct {
	Face string
	Size int
}

Font is a component that contains a font name as a string, and a font size in pixels.

The font name is used for resolving a font file on the host machine.

func (*Font) ExportToLua

func (component *Font) ExportToLua(state *lua.LState, table *lua.LTable) *lua.LTable

ExportToLua exports the component into the given table, using the given lua state machine.

func (*Font) New

func (*Font) New() akara.Component

New creates a new alpha component instance. The default alpha is opaque with value 1.0