TriggerReader Class

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

A Reader that is used to get Variables, Strings, and Numbers from Triggers

Inheritance Hierarchy

SystemObject
MonkeyspeakTriggerReader

Namespace: Monkeyspeak
Assembly: Monkeyspeak (in Monkeyspeak.dll) Version: 7.0.10.28723 (7.0.10.28723)

Syntax

[CLSCompliantAttribute(false)]
public sealed class TriggerReader

<CLSCompliantAttribute(false)>
Public NotInheritable Class TriggerReader

[CLSCompliantAttribute(false)]
public ref class TriggerReader sealed

[<SealedAttribute>]
[<CLSCompliantAttribute(false)>]
type TriggerReader =  class end

The TriggerReader type exposes the following members.

Constructors

	Name	Description
	TriggerReader	A Reader that is used to get Variables, Strings, and Numbers from Triggers

Properties

	Name	Description
	CurrentBlock	Gets the current block of triggers.
	CurrentBlockIndex
	Engine
	Page	Gets the page.
	Parameters	Gets or sets the parameters.
	Trigger	Gets the trigger.
	TriggerCategory	Gets the trigger category.
	TriggerId	Gets the trigger identifier.

Methods

	Name	Description
	GetParameterT	Gets the parameter.
	PeekNumber	Peeks at the next value
	PeekString	Peeks at the next value
	PeekVariable	Peeks at the next value
	PeekVariableT	Peeks at the next value, if the next value is not of T, returns false.
	PeekVariableTable	Peeks at the next value
	ReadNumber	Reads the next Number available, throws TriggerReaderException on failure
	ReadString	Reads the next String, throws TriggerReaderException on failure
	ReadVariable	Reads the next Variable available, throws TriggerReaderException on failure
	ReadVariableOrNumber	Reads the next Variable or Number available, throws TriggerReaderException on failure
	ReadVariableTable	Reads the next Variable table available and the key if there is one, throws TriggerReaderException on failure
	Reset	Resets the reader's indexes to 0
	TryGetParameterT	Tries the get the parameter at the specified index.
	TryReadNumber	Tries the read a number from the trigger.
	TryReadString	Tries the read a string from the trigger.
	TryReadVariable	Trys to read the next Variable available

Extension Methods

	Name	Description
	AsT	(Defined by ObjectExtensions.)