engine

const (
	ActUnk ActionArg = iota
	ActBegin
	ActEnter
	ActLook
	ActFlash
	ActObjDesc
	ActEnd

	// Combat modes — passed to NPC Action handlers by the fight system.
	ActBusy        // villain acts alone (player not present)
	ActDead        // villain has been killed
	ActUnconscious // villain knocked unconscious
	ActConscious   // villain regains consciousness
	ActFirst       // villain's first-strike check
)

const (
	// ClauseUnk means no clause is active.
	ClauseUnk ClauseTyp = iota
	// Clause1 refers to the first object clause.
	Clause1
	// Clause2 refers to the second object clause.
	Clause2
)

const (
	North Direction = iota
	South
	East
	West
	NorthEast
	NorthWest
	SouthEast
	SouthWest
	Up
	Down
	In
	Out
	Land
	NumDirections // sentinel — must be last
)

const (
	// FindAll searches the entire subtree.
	FindAll FindTyp = iota
	// FindTop searches only direct children.
	FindTop
	// FindBottom searches only nested (non-direct) children.
	FindBottom
)

const (
	// FlgUnk means the value is undefined (zero value, no bits set).
	FlgUnk Flags = 0

	// FlgTake means the object can be picked up by the player.
	FlgTake Flags = 1 << iota
	// FlgTryTake means the object shouldn't be implicitly taken.
	FlgTryTake
	// FlgCont means the object can contain other objects.
	FlgCont
	// FlgDoor means the object is a door.
	FlgDoor
	// FlgOpen means the object can be opened.
	FlgOpen
	// FlgSurf refers to objects such as table, desk, countertop.
	FlgSurf
	// FlgLock means the object is locked and can't be implicitly opened.
	FlgLock
	// FlgWear means the object can be worn by the player.
	FlgWear
	// FlgWorn means the object is currently being worn by the player.
	FlgWorn
	// FlgRead means the object can be read.
	FlgRead
	// FlgLight means the object can be turned on/off.
	FlgLight
	// FlgOn means the object's properties such as Light or Flame are turned on.
	FlgOn
	// FlgFlame means the object can be a source of fire.
	FlgFlame
	// FlgBurn means the object can be burnt.
	FlgBurn
	// FlgTrans means the objects inside can be seen even when it's closed.
	FlgTrans
	// FlgNoDesc means the object shouldn't be described.
	FlgNoDesc
	// FlgInvis means the object shouldn't be found.
	FlgInvis
	// FlgTouch means the object has interacted with the player.
	FlgTouch
	// FlgSearch means to find anything in the object the parser should look as deep as possible.
	FlgSearch
	// FlgVeh means the object can transport the player.
	FlgVeh
	// FlgPerson means the object is a character.
	FlgPerson
	// FlgFemale means the object is a female character.
	FlgFemale
	// FlgVowel means the object's description starts with a vowel.
	FlgVowel
	// FlgNoArt means the object's description doesn't work with articles.
	FlgNoArt
	// FlgPlural means the object's description is a plural noun.
	FlgPlural
	// FlgLand means the object is a dry land room.
	FlgLand
	// FlgWater means the object is a water room.
	FlgWater
	// FlgAir means the object is a room mid-air.
	FlgAir
	// FlgOut means the object is an outdoors room.
	FlgOut
	// FlgIntegral means the object is an integral part of another object.
	FlgIntegral
	// FlgBodyPart means the object is a body part.
	FlgBodyPart
	// FlgNotAll means the object shouldn't be taken when taking all.
	FlgNotAll
	// FlgDrop means if dropping objects in the vehicle the object should stay in the vehicle.
	FlgDrop
	// FlgIn means the player should stay in the vehicle rather than on.
	FlgIn
	// FlgKludge is a syntax flag which can be used to support a syntax VERB PREPOSITION without any object.
	FlgKludge
	// FlgFight means the character is actively engaged in combat.
	FlgFight
	// FlgStaggered means the character is recovering from a blow and will skip their next attack.
	FlgStaggered
	// FlgSacred means the object is protected and cannot be stolen by the thief.
	FlgSacred
	// FlgTool means the object can be used as an implement (e.g. for digging, inflating, locking).
	FlgTool
	// FlgNonLand means the room is a non-land area.
	FlgNonLand
	// FlgMaze means the room is a maze.
	FlgMaze
	// FlgClimb means the object can be climbed.
	FlgClimb
	// FlgWeapon means the object is a weapon.
	FlgWeapon
	// FlgDrink means the object can be drunk.
	FlgDrink
	// FlgFood means the object can be eaten.
	FlgFood
	// FlgTurn means the object can be turned.
	FlgTurn
	// FlgDestroyed means the room is munged/destroyed.
	FlgDestroyed
	// FlgRLand means the room becomes dry land conditionally.
	FlgRLand
	// FlgActor means the object is an actor.
	FlgActor
)

const (
	// GetUndef means no explicit quantifier was given.
	GetUndef GetObjTyp = iota
	// GetAll means the player said "all" / "everything".
	GetAll
	// GetOne means the player said "one" / "a".
	GetOne
	// GetInhibit suppresses object resolution.
	GetInhibit
)

const (
	// LocHeld means the object must be directly held by the actor.
	LocHeld LocFlag = 1 << iota
	// LocCarried means the object must be carried (held or in a carried container).
	LocCarried
	// LocInRoom means the object must be in the current room.
	LocInRoom
	// LocOnGrnd means the object must be on the ground.
	LocOnGrnd
	// LocTake means the parser may attempt an implicit take.
	LocTake
	// LocMany means multiple direct objects are allowed.
	LocMany
	// LocHave means the object must already be possessed.
	LocHave
)

const LocAll LocFlags = LocFlags(LocHeld | LocCarried | LocInRoom | LocOnGrnd | LocTake | LocMany | LocHave)

const (
	// PerfNotHndld means no handler claimed the action.
	PerfNotHndld PerformResult = iota
	// PerfHndld means a handler processed the action.
	PerfHndld
	// PerfFatal means the action caused a fatal condition (e.g. player death).
	PerfFatal
	// PerfQuit means the player requested to quit.
	PerfQuit
)

const (
	// WordUnk is the zero value for an unrecognized word.
	WordUnk WordTyp = iota
	// WordDir indicates a compass direction (north, south, etc.).
	WordDir
	// WordVerb indicates a verb (take, open, etc.).
	WordVerb
	// WordPrep indicates a preposition (in, on, with, etc.).
	WordPrep
	// WordAdj indicates an adjective (brass, large, etc.).
	WordAdj
	// WordObj indicates a noun / object name (lamp, sword, etc.).
	WordObj
	// WordBuzz indicates a filler word that is ignored (the, a, etc.).
	WordBuzz
)