script

type BaseGame struct{}

type BaseObject struct{}

type BasePlayer struct{}

type BaseWall struct{}

type BaseWaypoint struct{}

type Breakable interface {
	Destroyable
	// Health returns current and max health of the object.
	Health() (cur, max int)
	// SetHealth sets the amount of health of the object. It will be limited by max health.
	SetHealth(v int)
	// SetMaxHealth sets the maximal amount of health of the object. It will be adjust health accordingly.
	SetMaxHealth(v int)
}

type Chatty interface {
	// Say displays the chat bubble on this object.
	// If the duration is set, the bubble will disappear after it passes.
	Say(text string, dur ns4.Duration)
	// Mute removes the current chat bubble, if any.
	Mute()
}

type Deleter interface {
	// Delete the object permanently.
	Delete()
}

type Destroyable interface {
	// Destroy this object. Implies reducing health to zero and playing break/death effects.
	Destroy()
}

type Duration = ns4.Duration

type EnableSetter interface {
	// Enable or disable the object.
	Enable(enable bool)
}

type Enabler interface {
	// IsEnabled checks if object is currently enabled.
	IsEnabled() bool
	EnableSetter
}

type EventType string

type Game interface {
	TimeSource

	// BlindPlayers blinds or unblinds all players.
	BlindPlayers(blind bool)
	// CinemaPlayers enables a wide-screen "cinema" mode for all players.
	CinemaPlayers(v bool)
	// Players returns a list of all players.
	Players() []Player
	// HostPlayer returns the host player.
	HostPlayer() Player
	// OnPlayerJoin registers a player join event handler.
	OnPlayerJoin(fnc func(p Player))
	// OnPlayerLeave registers a player leave event handler.
	OnPlayerLeave(fnc func(p Player))

	// ObjectTypeByID finds an object type by ID.
	ObjectTypeByID(id string) ObjectType
	// ObjectByID finds an object by ID.
	ObjectByID(id string) Object
	// ObjectGroupByID finds an object group by ID.
	ObjectGroupByID(id string) *ObjectGroup

	// WaypointByID finds a waypoint by ID.
	WaypointByID(id string) Waypoint
	// WaypointGroupByID finds a waypoint group by ID.
	WaypointGroupByID(id string) *WaypointGroup

	// WallAt finds a wall by its position.
	WallAt(pos types.Pointf) Wall
	// WallNear finds a wall near the position.
	WallNear(pos types.Pointf) Wall
	// WallAtGrid finds a wall by its grid position.
	WallAtGrid(pos image.Point) Wall
	// WallGroupByID finds a wall group by ID.
	WallGroupByID(id string) *WallGroup

	// AudioEffect creates an audio effect with a given name at a specified position. Position can be nil.
	AudioEffect(name string, pos Positioner)

	Global() Printer
	Console(error bool) Printer
}

type GridPositioner interface {
	// GridPos returns current position of the object on the grid.
	GridPos() image.Point
}

type Identifiable interface {
	fmt.Stringer
	// ID of the object.
	ID() string
}

type Inventory interface {
	// CountItem counts the number of given items in the inventory.
	CountItem(v Item) int
	// Items returns a list of all items. It ignores the stack size.
	Items() []Item
	// Gold returns amount of gold this inventory contains.
	Gold() int
	// SetGold sets the amount of gold this inventory contains.
	SetGold(v int)
}

type Item interface {
	Named
	// ItemType returns a type of this item.
	ItemType() ItemType
	// Amount returns current amount of this item.
	Amount() int
	// SetAmount sets an amount of a given item.
	SetAmount(v int)
	// CanStack checks if two items can be stacked together.
	CanStack(v Item) bool
}

type ItemType interface {
	Named
	// MaxStack returns maximal amount of this item an inventory slot can contain.
	MaxStack() int
}

type Living interface {
	Breakable
	// Mana returns current and max mana of the unit.
	Mana() (cur, max int)
	// SetMana sets the amount of mana of the object. It will be limited by max mana.
	SetMana(v int)
	// SetMaxMana sets the maximal amount of mana of the object. It will be adjust mana accordingly.
	SetMaxMana(v int)
}

type Lockable interface {
	// IsLocked checks if object is currently locked.
	IsLocked() bool
	// Lock or unlock the object.
	Lock(lock bool)
}

type LockableObject interface {
	Object
	Lockable
}

type Mobile interface {
	// MoveTo forces the unit to move to a location. More generic than WalkTo.
	MoveTo(p types.Pointf)
	// WalkTo forces the unit to walk to a location.
	WalkTo(p types.Pointf)
	// LookAt forces the unit to look at the location.
	LookAt(p types.Pointf)
	// LookAtDir forces the unit to look in a given direction.
	LookAtDir(dir int)
	// LookAngle forces unit to look at a given angle.
	LookAngle(ang int)
	// Freeze or unfreeze an object in place.
	Freeze(freeze bool)
	// Wander makes this unit wander around.
	Wander()
	// Return makes this unit to return to its starting position.
	Return()
	// Idle makes an object idle.
	Idle()
	// Follow a given object.
	Follow(obj Positioner)
	// Flee from a given object for a certain duration.
	Flee(obj Positioner, dur ns4.Duration)
}

type Named interface {
	fmt.Stringer
	// Name returns a name of the item.
	Name() string
}

type Object interface {
	// ScriptID returns internal script ID for the object.
	ScriptID() int
	// ObjScriptID returns internal script ID for the object.
	ObjScriptID() int
	Identifiable
	ObjectWrapper
	Class() object.Class
	ObjectType() ObjectType
	Ownable
	Physical
	Enabler
	Deleter
	Destroyable
	Trigger // TODO: move those to a separate type eventually
}

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

type ObjectType interface {
	Identifiable
	CreateObject(p types.Pointf) Object
}

type ObjectWrapper interface {
	// GetObject returns an underlying object.
	GetObject() Object
}

type Offensive interface {
	OffensiveGroup
	// Aggression returns current aggression level.
	Aggression() float32
	// RetreatLevel returns current retreat level.
	RetreatLevel() float32
	// RegroupLevel returns current regroup level.
	RegroupLevel() float32
}

type OffensiveGroup interface {
	// SetAggression sets aggression level.
	SetAggression(v float32)
	// SetRetreatLevel sets retreat level, causing the creature to flee on low health.
	SetRetreatLevel(v float32)
	// SetRegroupLevel sets regroup level, causing the creature to return to fight when health restores.
	SetRegroupLevel(v float32)
	// Attack another object.
	Attack(obj Positioner)
	// HitMelee forces the unit to melee attack the location.
	HitMelee(p types.Pointf)
	// HitRanged forces the unit to ranged attack the location.
	HitRanged(p types.Pointf)
	// Guard makes an object guard location.
	Guard()
	// Hunt makes an object hunt for enemies.
	Hunt()
	// Cast a specific spell level at a given location. If location is nil, it will be cast on self.
	Cast(spell spell.ID, level int, target Positioner) bool
}

type Ownable interface {
	Owned
	OwnerSetter
}

type Owned interface {
	Owner() Object
}

type OwnerSetter interface {
	SetOwner(owner ObjectWrapper)
}

type Physical interface {
	Raisable
	Pushable
}

type Player interface {
	ObjectWrapper // proxies to Unit
	Positionable  // proxies to Unit
	Named
	// IsHost checks if this player hosts the game.
	IsHost() bool
	Printer
	// Blind or unblind the player.
	Blind(v bool)
	// Cinema enables wide-screen "cinema" mode.
	Cinema(v bool)
	// Unit that the player controls.
	Unit() Unit
}

type PositionSetter interface {
	// SetPos instantly moves object to a given position.
	SetPos(p types.Pointf)
}

type Positionable interface {
	Positioner
	PositionSetter
}

type Positioner interface {
	// Pos returns current position of the object.
	Pos() types.Pointf
}

type Printer interface {
	// Print a text message.
	Print(text string)
}

type Pushable interface {
	// Push applies a force to the object based on the vector and magnitude.
	Push(vec types.Pointf, force float32)
	// PushTo pushes an object to a specific location.
	PushTo(p types.Pointf)
}

type Raisable interface {
	Positionable
	ZPositioner
	// SetZ sets Z offset for the object.
	SetZ(z float32)
}

type TimeSource = ns4.TimeSource

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

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

type Toggler interface {
	// Toggle the object's enabled state.
	// It returns the new state after toggling the object.
	Toggle() bool
}

type Trigger interface {
	OnTriggerActivate(fnc func(obj Object))
	OnTriggerDeactivate(fnc func())
}

type Unit interface {
	Object
	// CanSee checks if this unit can see an object.
	CanSee(obj Object) bool
	Living
	Mobile
	Offensive
	Chatty // TODO: should be on object?
	// OnUnitDeath calls the function when the unit dies.
	OnUnitDeath(fnc func())
	// OnUnitIdle calls the function when the unit becomes idle.
	OnUnitIdle(fnc func())
	// OnUnitDone calls the function when the unit completes its task.
	OnUnitDone(fnc func())
	// OnUnitAttack calls the function when the unit starts attacking another unit.
	OnUnitAttack(fnc func(targ Unit))
	// OnUnitSeeEnemy calls the function when the unit notices an enemy.
	OnUnitSeeEnemy(fnc func(targ Unit))
	// OnUnitLostEnemy calls the function when the unit loses sight of an enemy.
	OnUnitLostEnemy(fnc func(targ Unit))
}

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

type VM interface {
	// Exec executes text as a script source code.
	Exec(s string) (reflect.Value, error)
	// ExecFile executes a script from the file or directory.
	ExecFile(path string) error
	// OnFrame must be called when a new game frame is complete.
	OnFrame()
	// OnEvent is called when a certain scrip event happens.
	OnEvent(typ EventType)
	// GetSymbol tries to find a function or variable with a given name and type.
	// If symbol is found, but type doesn't match, it returns an error.
	// If symbol is not found, it returns reflect.Value{}, false, nil.
	GetSymbol(name string, typ reflect.Type) (reflect.Value, bool, error)
	// Close the VM and free resources.
	Close() error
}

type VMRuntime struct {
	// Log is the logger for this VM runtime.
	Log *log.Logger
	// Name is a short name for the VM runtime. Must be unique.
	Name string
	// Title is a human-friendly name for the VM runtime.
	Title string
	// NewMap creates a new script VM for map scripts.
	// If there's no scripts for the map, function may return nil, nil.
	NewMap func(g Game, maps string, name string) (VM, error)
}

type Wall interface {
	fmt.Stringer
	Positioner
	GridPositioner
	Enabler // opens and closes the wall
	Destroyable
}

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

type Waypoint interface {
	Identifiable
	Enabler
	Positionable
}

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

type ZPositioner interface {
	// Z returns current Z offset for the object.
	Z() float32
}