Instruction Class

Instruction Class

Hartismere School

[This is preliminary documentation and is subject to change.]

Describes the player's input.

Inheritance Hierarchy

SystemObject
EJW.TextBasedAdventureInstruction

Namespace: EJW.TextBasedAdventure
Assembly: EJW.TextBasedAdventure (in EJW.TextBasedAdventure.dll) Version: 2.0.5850.21153

Syntax

[SerializableAttribute]
public class Instruction

<SerializableAttribute>
Public Class Instruction

[SerializableAttribute]
public ref class Instruction

[<SerializableAttribute>]
type Instruction =  class end

The Instruction type exposes the following members.

Properties

	Name	Description
	Direction	...can be null if no direction entered.
	Parsed	recognised text after parsing.
	Preposition	text of recognised preposition.
	Raw	the raw text entered by the user.
	RawWords	string[] of words in raw text
	ResultText	Contains the resulting text that will be displayed to the player from teh current instruction.
	RoomChanged	shows true if the current room has been changed.
	Speech	An instruction contained in speech marks
	Thing1
	Thing2
	Verb	Text of recognised verb.

Methods

	Name	Description
	Break	Prevent any further actions in this parse executing.
	IsWordInRaw	Checks all the words entered by the player for a match with Word
	Match(String)	Provides a shortcut for matching the verb in the current Instruction
	Match(String, Thing)	Provides a shortcut for matching the verb and first Thing in the current Instruction
	Match(String, Thing, String, Thing)	Provides a shortcut for matching the verb and first Thing in the current Instruction