world

README

Overview

The World plugin provides the bulk of the functionality for a typical Mjolnir based game.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

• Using welcoming and inclusive language
• Being respectful of differing viewpoints and experiences
• Gracefully accepting constructive criticism
• Focusing on what is best for the community
• Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

• The use of sexualized language or imagery and unwelcome sexual attention or advances
• Trolling, insulting/derogatory comments, and personal or political attacks
• Public or private harassment
• Publishing others' private information, such as a physical or electronic address, without explicit permission
• Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

Documentation

Index

• Variables
• func AddEntity(name string, id string, args map[string]interface{}) error
• func GetBoolComponent(id string, name string) (bool, error)
• func GetInt64Component(id string, name string) (int64, error)
• func GetIntComponent(id string, name string) (int, error)
• func GetIntFromHashComponent(id string, name string, key string) (int, error)
• func GetStringComponent(id string, name string) (string, error)
• func GetStringFromHashComponent(id string, name string, key string) (string, error)
• func ParseCommand(sets []string, session session.Session, input string)
• func RegisterCommandSet(set *command_set.CommandSet)
• func RegisterController(controller session.Controller)
• func RegisterEntityType(entityType entity_type.EntityType)
• func RegisterLoadableDirectory(dir string)
• func RegisterSystem(system system.System)
• func RemoveEntity(id string)
• func SetBoolComponent(id string, name string, value bool)
• func SetInt64Component(id string, name string, value int64)
• func SetIntComponent(id string, name string, value int)
• func SetIntInHashComponent(id string, name, key string, value int)
• func SetStringComponent(id string, name, value string)
• func SetStringInHashComponent(id string, name, hash, value string)
• func WriteToConnection(id string, data string)
• func WriteToConnectionF(id string, format string, args ...interface{})

Variables

var Plugin = world{
	// contains filtered or unexported fields
}

Functions

func AddEntity

func AddEntity(name string, id string, args map[string]interface{}) error

func GetBoolComponent

func GetBoolComponent(id string, name string) (bool, error)

func GetInt64Component

func GetInt64Component(id string, name string) (int64, error)

GetInt64Component returns the value of an int64 component.

func GetIntComponent

func GetIntComponent(id string, name string) (int, error)

GetIntComponent returns the value of an int component.

func GetIntFromHashComponent

func GetIntFromHashComponent(id string, name string, key string) (int, error)

GetIntFromHashComponent returns the value of an int value from a hash component.

func GetStringComponent

func GetStringComponent(id string, name string) (string, error)

GetStringComponent returns the value of a string component.

func GetStringFromHashComponent

func GetStringFromHashComponent(id string, name string, key string) (string, error)

GetStringFromHashComponent returns the value of a string value from a hash component.

func ParseCommand

func ParseCommand(sets []string, session session.Session, input string)

func RegisterCommandSet

func RegisterCommandSet(set *command_set.CommandSet)

RegisterCommandSet registers a command set with the world.

func RegisterController

func RegisterController(controller session.Controller)

RegisterController registers a controller with the world.

func RegisterEntityType

func RegisterEntityType(entityType entity_type.EntityType)

RegisterEntityType registers an entity type with the world.

func RegisterLoadableDirectory

func RegisterLoadableDirectory(dir string)

RegisterLoadableDirectory registers a directory to be loaded.

func RegisterSystem

func RegisterSystem(system system.System)

RegisterSystem registers a system with the world.

func RemoveEntity

func RemoveEntity(id string)

func SetBoolComponent

func SetBoolComponent(id string, name string, value bool)

func SetInt64Component

func SetInt64Component(id string, name string, value int64)

func SetIntComponent

func SetIntComponent(id string, name string, value int)

func SetIntInHashComponent

func SetIntInHashComponent(id string, name, key string, value int)

func SetStringComponent

func SetStringComponent(id string, name, value string)

func SetStringInHashComponent

func SetStringInHashComponent(id string, name, hash, value string)

func WriteToConnection

func WriteToConnection(id string, data string)

func WriteToConnectionF

func WriteToConnectionF(id string, format string, args ...interface{})