game

type Callback func(Play)

type IList interface {
	// Len returns the number of values in the list.
	Len() int
	// Get returns the value of the nth values in the list.
	Get(int) IValue
	// Contains returns true if the passed parameter exists in the list.
	// The parameter can be an IValue, IObject, number, text.
	Contains(interface{}) bool

	// AppendNum adds the passed number to the end of the list.
	AppendNum(float64)
	// AppendText adds the passed string to the end of the list.
	AppendText(string)
	// AppendObject adds the passed object to the end of the list.
	AppendObject(IObject)

	// Pop removes the last value from the list.
	Pop() IValue
	// Reset the list by completely emptying it.
	Reset()
}

type IObject interface {
	Id() ident.Id
	Exists() bool // FIX: added for obj.Object() tests, alternatives?
	// FromClass returns true if the object was derived from the passed plural named class.
	// FIX: seems to programmery, alternatives?
	FromClass(string) bool
	// Parent returns the spatial parent, enclosure, of an object.
	// by default, there is no such object, the standard rules, etc. define their own thing.
	ParentRelation() (IObject, string)

	Is(string) bool
	IsNow(string)
	Equals(IObject) bool

	// Get returns the named property.
	Get(string) IValue

	// List returns the named list.
	List(string) IList

	// Go run an action defined on this object.
	Go(action string, withTargetAndContext ...IObject) IPromise

	// FIX: this should probably just be an action.
	// Go("say", ...)
	Says(string)

	// deprecated: prefer Get()
	Num(string) float64
	SetNum(string, float64)

	Object(string) IObject
	ObjectList(string) []IObject
	Set(string, IObject)

	Text(string) string
	SetText(string, string)
}

type IPromise interface {
	Then(Callback)
}

type IQuery interface {
	HasNext() bool
	Next() IObject
}

type IValue interface {
	Num() float64
	SetNum(float64)

	Object() IObject
	SetObject(IObject)

	Text() string
	SetText(string)

	State() ident.Id
	SetState(ident.Id)
}

type Play interface {
	// The function retrieves a script declared instance.
	The(noun string) IObject
	// Our alias for The.
	Our(noun string) IObject
	// A(n) alias for The.
	A(noun string) IObject
	// Say friendly narrative print.
	Say(text ...string)
	// Log a quiet print.
	Log(text ...interface{})
	// List one or more objects by class name.
	// FUTURE: replace class by an index?
	// ALT: broadcast an event to an optionally query/filtered set of objects.
	Query(class string, exact bool) IQuery
	// StopHere.
	// FIX: move into the event object, possible via callback parameter injection
	StopHere()
	// Go queue the passed runtime phrases for future execution.
	Go(RuntimePhrase, ...RuntimePhrase) IPromise
	// Random returns a number ranging from 0 to n, not including n.
	Random(n int) int
}

type RuntimePhrase interface {
	Execute(Play)
}