entities

Documentation

Overview

Package entities stores useful object and entity types, such as positions and renderables, collision spaces and renderables, and delta / speed vectors built into the above types.

A number of the functions used by the types in entities assume that legacy behavior is being used.

Index

• type Doodad
  • func NewDoodad(x, y float64, r render.Renderable, CID event.CID) Doodad
  • func (d *Doodad) Destroy()
  • func (d *Doodad) GetID() event.CID
  • func (d *Doodad) GetRenderable() render.Renderable
  • func (d *Doodad) Init() event.CID
  • func (d *Doodad) SetPos(x, y float64)
  • func (d *Doodad) SetRenderable(r render.Renderable)
  • func (d *Doodad) String() string
• type Interactive
  • func NewInteractive(x, y, w, h float64, r render.Renderable, cid event.CID, friction float64) Interactive
  • func (v *Interactive) ApplyFriction(outsideFriction float64)
  • func (v Interactive) GetDelta() physics.Vector
  • func (iv *Interactive) Init() event.CID
• type Moving
  • func NewMoving(x, y, w, h float64, r render.Renderable, cid event.CID, friction float64) Moving
  • func (v *Moving) ApplyFriction(outsideFriction float64)
  • func (v Moving) GetDelta() physics.Vector
  • func (m *Moving) Init() event.CID
  • func (m *Moving) ShiftVector(v physics.Vector)
• type Point
  • func NewPoint(x, y float64) Point
  • func (p *Point) DistanceTo(x, y float64) float64
  • func (p *Point) DistanceToPoint(p2 Point) float64
  • func (p *Point) GetLogicPos() (float64, float64)
  • func (p *Point) SetLogicPos(x, y float64)
  • func (p *Point) String() string
• type Reactive
  • func NewReactive(x, y, w, h float64, r render.Renderable, cid event.CID) Reactive
  • func (r *Reactive) Destroy()
  • func (r *Reactive) GetLogicDim() (float64, float64)
  • func (r *Reactive) GetSpace() *collision.Space
  • func (r *Reactive) Init() event.CID
  • func (r *Reactive) SetDim(w, h float64)
  • func (r *Reactive) SetLogicDim(w, h float64)
  • func (r *Reactive) SetPos(x, y float64)
  • func (r *Reactive) SetSpace(sp *collision.ReactiveSpace)
  • func (r *Reactive) ShiftPos(x, y float64)
  • func (r *Reactive) String() string
• type Solid
  • func NewSolid(x, y, w, h float64, r render.Renderable, cid event.CID) Solid
  • func (s *Solid) Destroy()
  • func (s *Solid) GetLogicDim() (float64, float64)
  • func (s *Solid) GetSpace() *collision.Space
  • func (s *Solid) Init() event.CID
  • func (s *Solid) SetDim(w, h float64)
  • func (s *Solid) SetLogicDim(w, h float64)
  • func (s *Solid) SetPos(x float64, y float64)
  • func (s *Solid) SetSpace(sp *collision.Space)
  • func (s *Solid) ShiftPos(x, y float64)
  • func (s *Solid) ShiftX(x float64)
  • func (s *Solid) ShiftY(y float64)
  • func (s *Solid) String() string

Types

type Doodad

type Doodad struct {
	Point
	event.CID
	R render.Renderable
}

A Doodad is an entity composed of a position, a renderable, and a CallerID.

func NewDoodad

func NewDoodad(x, y float64, r render.Renderable, CID event.CID) Doodad

NewDoodad returns a new doodad that is not drawn but is initialized. Passing a CID of 0 will initialize the entity as a Doodad. Passing any other CID will assume that the struct containing this doodad has already been initialized to the passed in CID. This applies to ALL NewX functions in entities which take in a CID.

func (*Doodad) Destroy

func (d *Doodad) Destroy()

Destroy cleans up the events, renderable and entity mapping for this Doodad

func (*Doodad) GetID

func (d *Doodad) GetID() event.CID

GetID returns this Doodad's CID Consider: are these getters needed?

func (*Doodad) GetRenderable

func (d *Doodad) GetRenderable() render.Renderable

GetRenderable returns this Doodad's Renderable

func (*Doodad) Init

func (d *Doodad) Init() event.CID

Init satisfies event.Entity

func (*Doodad) SetPos

func (d *Doodad) SetPos(x, y float64)

SetPos both Sets logical position and renderable position The need for this sort of function is lessened with the introduction of vector attachement.

func (*Doodad) SetRenderable

func (d *Doodad) SetRenderable(r render.Renderable)

SetRenderable sets this Doodad's renderable, drawing it. Todo:this automatic drawing doesn't really work with our two tiers of draw layers

func (*Doodad) String

func (d *Doodad) String() string

type Interactive

type Interactive struct {
	Reactive
	// contains filtered or unexported fields
}

Interactive parallels Moving, but for Reactive instead of Solid

func NewInteractive

func NewInteractive(x, y, w, h float64, r render.Renderable, cid event.CID, friction float64) Interactive

NewInteractive returns a new Interactive

func (*Interactive) ApplyFriction

func (v *Interactive) ApplyFriction(outsideFriction float64)

ApplyFriction modifies a moving's delta by combining environmental friction with the moving's base friction and scaling down the delta by the combined result.

func (Interactive) GetDelta

func (v Interactive) GetDelta() physics.Vector

GetDelta returns this moving's delta

func (*Interactive) Init

func (iv *Interactive) Init() event.CID

Init satisfies event.Entity

type Moving

type Moving struct {
	Solid
	// contains filtered or unexported fields
}

A Moving is a Solid that also keeps track of a speed and a delta vector

func NewMoving

func NewMoving(x, y, w, h float64, r render.Renderable, cid event.CID, friction float64) Moving

NewMoving returns a new Moving

func (*Moving) ApplyFriction

func (v *Moving) ApplyFriction(outsideFriction float64)

ApplyFriction modifies a moving's delta by combining environmental friction with the moving's base friction and scaling down the delta by the combined result.

func (Moving) GetDelta

func (v Moving) GetDelta() physics.Vector

GetDelta returns this moving's delta

func (*Moving) Init

func (m *Moving) Init() event.CID

Init satisfies event.Entity

func (*Moving) ShiftVector

func (m *Moving) ShiftVector(v physics.Vector)

ShiftVector probably shouldn't be on moving but it lets you ShiftPos by a given vector

type Point

type Point struct {
	physics.Vector
}

A Point is a wrapper around a physics vector.

func NewPoint

func NewPoint(x, y float64) Point

NewPoint returns a new point

func (*Point) DistanceTo

func (p *Point) DistanceTo(x, y float64) float64

DistanceTo returns the euclidean distance to (x,y)

func (*Point) DistanceToPoint

func (p *Point) DistanceToPoint(p2 Point) float64

DistanceToPoint returns the euclidean distance to p2.GetLogicPos()

func (*Point) GetLogicPos

func (p *Point) GetLogicPos() (float64, float64)

GetLogicPos returns the logical position of an entity. See SetLogicPos.

func (*Point) SetLogicPos

func (p *Point) SetLogicPos(x, y float64)

SetLogicPos is an explicit declaration for setting just the logical position of an entity. On a Point there is no distinction as there is nothing but the logical position but this is important for other entity types

func (*Point) String

func (p *Point) String() string

type Reactive

type Reactive struct {
	Doodad
	W, H   float64
	RSpace *collision.ReactiveSpace
}

Reactive is parallel to Solid, but has a Reactive collision space instead of a regular collision space

func NewReactive

func NewReactive(x, y, w, h float64, r render.Renderable, cid event.CID) Reactive

NewReactive returns a new reactive

func (*Reactive) Destroy

func (r *Reactive) Destroy()

Destroy destroys this reactive's doodad component and removes its space from the default collision tree (todo: legacy, fix this)

func (*Reactive) GetLogicDim

func (r *Reactive) GetLogicDim() (float64, float64)

GetLogicDim returns this Reactive's width and height todo: move wh into their own struct to compose into solid and reactive

func (*Reactive) GetSpace

func (r *Reactive) GetSpace() *collision.Space

GetSpace returns this reactive's space underlying its RSpace

func (*Reactive) Init

func (r *Reactive) Init() event.CID

Init satisfies event.Entity

func (*Reactive) SetDim

func (r *Reactive) SetDim(w, h float64)

SetDim sets the dimensions of this reactive's space and it's logical dimensions

func (*Reactive) SetLogicDim

func (r *Reactive) SetLogicDim(w, h float64)

SetLogicDim sets the logical width and height of this reactive without changing the real dimensions of its collision space

func (*Reactive) SetPos

func (r *Reactive) SetPos(x, y float64)

SetPos sets this reactive's logical, renderable, and collision position to be x,y

func (*Reactive) SetSpace

func (r *Reactive) SetSpace(sp *collision.ReactiveSpace)

SetSpace sets this reactive's collision space to the given reactive space, updating the default collision tree to include it. Todo: fix that

func (*Reactive) ShiftPos

func (r *Reactive) ShiftPos(x, y float64)

ShiftPos acts like SetPos if given r.X()+x, r.Y()+y

func (*Reactive) String

func (r *Reactive) String() string

type Solid

type Solid struct {
	Doodad
	W, H  float64
	Space *collision.Space
}

A Solid is a Doodad with a width, height, and collision space.

func NewSolid

func NewSolid(x, y, w, h float64, r render.Renderable, cid event.CID) Solid

NewSolid returns an initialized Solid that is not drawn and whose space belongs to no collision tree

func (*Solid) Destroy

func (s *Solid) Destroy()

Destroy removes this solid's collision space from the default tree (todo) and destroys the doodad portion of the solid.

func (*Solid) GetLogicDim

func (s *Solid) GetLogicDim() (float64, float64)

GetLogicDim will return the width and height of the Solid

func (*Solid) GetSpace

func (s *Solid) GetSpace() *collision.Space

GetSpace returns a solid's collision space

func (*Solid) Init

func (s *Solid) Init() event.CID

Init satisfies event.Entity

func (*Solid) SetDim

func (s *Solid) SetDim(w, h float64)

SetDim sets the logical dimensions of the solid and the real dimensions on the solid's space

func (*Solid) SetLogicDim

func (s *Solid) SetLogicDim(w, h float64)

SetLogicDim sets the width and height of the solid

func (*Solid) SetPos

func (s *Solid) SetPos(x float64, y float64)

SetPos sets the position of the collision space, the logical position, and the renderable position of the solid.

func (*Solid) SetSpace

func (s *Solid) SetSpace(sp *collision.Space)

SetSpace assigns a solid a collision space and puts it in the default collision tree. This is legacy behavior that should change.

func (*Solid) ShiftPos

func (s *Solid) ShiftPos(x, y float64)

ShiftPos moves a solid by (x,y)

func (*Solid) ShiftX

func (s *Solid) ShiftX(x float64)

ShiftX moves a solid by x along the x axis

func (*Solid) ShiftY

func (s *Solid) ShiftY(y float64)

ShiftY moves a solid by y along the y axis

func (*Solid) String

func (s *Solid) String() string