mirror of
https://github.com/OpenDiablo2/OpenDiablo2
synced 2025-02-13 12:06:31 -05:00
c52c6648dd
Systems now place all of their component factories into a `Components` member. This improves code readability and makes it clear when we are dealing specifically with ecs components. The concrete ComponentFactory instances now have `Add` and `Get` methods (as opposed to `AddAlpha` or `GetAlpha`). This enforces naming of component factories as to avoid collisions when embedded in a struct with other components. Also, the ComponentFactory interface is embedded directly into the concrete component factory without a name.
43 lines
1.4 KiB
Go
43 lines
1.4 KiB
Go
//nolint:dupl,golint,stylecheck // component declarations are supposed to look the same
|
|
package d2components
|
|
|
|
import (
|
|
"github.com/gravestench/akara"
|
|
|
|
"github.com/OpenDiablo2/OpenDiablo2/d2common/d2fileformats/d2pl2"
|
|
)
|
|
|
|
// static check that PaletteTransform implements Component
|
|
var _ akara.Component = &PaletteTransform{}
|
|
|
|
// PaletteTransform is a component that contains an embedded palette transform (pl2) struct
|
|
type PaletteTransform struct {
|
|
*d2pl2.PL2
|
|
}
|
|
|
|
// New returns a new PaletteTransform component. By default, it contains a nil instance.
|
|
func (*PaletteTransform) New() akara.Component {
|
|
return &PaletteTransform{}
|
|
}
|
|
|
|
// PaletteTransformFactory is a wrapper for the generic component factory that returns PaletteTransform component instances.
|
|
// This can be embedded inside of a system to give them the methods for adding, retrieving, and removing a PaletteTransform.
|
|
type PaletteTransformFactory struct {
|
|
*akara.ComponentFactory
|
|
}
|
|
|
|
// Add adds a PaletteTransform component to the given entity and returns it
|
|
func (m *PaletteTransformFactory) Add(id akara.EID) *PaletteTransform {
|
|
return m.ComponentFactory.Add(id).(*PaletteTransform)
|
|
}
|
|
|
|
// Get returns the PaletteTransform component for the given entity, and a bool for whether or not it exists
|
|
func (m *PaletteTransformFactory) Get(id akara.EID) (*PaletteTransform, bool) {
|
|
component, found := m.ComponentFactory.Get(id)
|
|
if !found {
|
|
return nil, found
|
|
}
|
|
|
|
return component.(*PaletteTransform), found
|
|
}
|