iteminternal

Documentation

Index

• func Components(it world.CustomItem) map[string]any
• type ComponentBuilder
  • func NewComponentBuilder(name, identifier string, category category.Category) *ComponentBuilder
  • func (builder *ComponentBuilder) AddComponent(name string, value any)
  • func (builder *ComponentBuilder) AddProperty(name string, value any)
  • func (builder *ComponentBuilder) Construct() map[string]any

Functions

func Components

func Components(it world.CustomItem) map[string]any

Components returns all the components of the given custom item. If the item has no components, a nil map and false are returned.

Types

type ComponentBuilder

type ComponentBuilder struct {
	// contains filtered or unexported fields
}

ComponentBuilder represents a builder that can be used to construct an item components map to be sent to a client.

func NewComponentBuilder

func NewComponentBuilder(name, identifier string, category category.Category) *ComponentBuilder

NewComponentBuilder returns a new component builder with the provided item data.

func (*ComponentBuilder) AddComponent

func (builder *ComponentBuilder) AddComponent(name string, value any)

AddComponent adds the provided component to the builder.

func (*ComponentBuilder) AddProperty

func (builder *ComponentBuilder) AddProperty(name string, value any)

AddProperty adds the provided property to the builder.

func (*ComponentBuilder) Construct

func (builder *ComponentBuilder) Construct() map[string]any

Construct constructs the final item components map and returns it. It also applies the default properties required for the item to work without modifying the original maps in the builder.