Click or drag to resize

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

The TriggerReader type exposes the following members.

Constructors
  NameDescription
Public methodTriggerReader
A Reader that is used to get Variables, Strings, and Numbers from Triggers
Top
Properties
  NameDescription
Public propertyCurrentBlock
Gets the current block of triggers.
Public propertyCurrentBlockIndex
Public propertyEngine
Public propertyPage
Gets the page.
Public propertyParameters
Gets or sets the parameters.
Public propertyTrigger
Gets the trigger.
Public propertyTriggerCategory
Gets the trigger category.
Public propertyTriggerId
Gets the trigger identifier.
Top
Methods
  NameDescription
Public methodGetParameterT
Gets the parameter.
Public methodPeekNumber
Peeks at the next value
Public methodPeekString
Peeks at the next value
Public methodPeekVariable
Peeks at the next value
Public methodPeekVariableT
Peeks at the next value, if the next value is not of T, returns false.
Public methodPeekVariableTable
Peeks at the next value
Public methodReadNumber
Reads the next Number available, throws TriggerReaderException on failure
Public methodReadString
Reads the next String, throws TriggerReaderException on failure
Public methodReadVariable
Reads the next Variable available, throws TriggerReaderException on failure
Public methodReadVariableOrNumber
Reads the next Variable or Number available, throws TriggerReaderException on failure
Public methodReadVariableTable
Reads the next Variable table available and the key if there is one, throws TriggerReaderException on failure
Public methodReset
Resets the reader's indexes to 0
Public methodTryGetParameterT
Tries the get the parameter at the specified index.
Public methodTryReadNumber
Tries the read a number from the trigger.
Public methodTryReadString
Tries the read a string from the trigger.
Public methodTryReadVariable
Trys to read the next Variable available
Top
Extension Methods
See Also