1
1
mirror of https://github.com/OpenDiablo2/OpenDiablo2 synced 2025-02-10 02:26:29 -05:00
OpenDiablo2/d2core/d2components/asset_data_dictionary.go
gravestench c52c6648dd refactor of d2components, d2systems
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.
2020-12-08 18:45:00 -08:00

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/d2txt"
)
// static check that DataDictionaryComponent implements Component
var _ akara.Component = &DataDictionary{}
// DataDictionary is a component that contains an embedded txt data dictionary struct
type DataDictionary struct {
*d2txt.DataDictionary
}
// New returns a DataDictionary component. By default, it contains a nil instance.
func (*DataDictionary) New() akara.Component {
return &AnimationData{}
}
// DataDictionaryFactory is a wrapper for the generic component factory that returns DataDictionary component instances.
// This can be embedded inside of a system to give them the methods for adding, retrieving, and removing a DataDictionary.
type DataDictionaryFactory struct {
*akara.ComponentFactory
}
// Add adds a DataDictionary component to the given entity and returns it
func (m *DataDictionaryFactory) Add(id akara.EID) *DataDictionary {
return m.ComponentFactory.Add(id).(*DataDictionary)
}
// Get returns the DataDictionary component for the given entity, and a bool for whether or not it exists
func (m *DataDictionaryFactory) Get(id akara.EID) (*DataDictionary, bool) {
component, found := m.ComponentFactory.Get(id)
if !found {
return nil, found
}
return component.(*DataDictionary), found
}