Dom Namespace Reference

Classes

class  NodeList
 
class  HTMLCollection
 A collection of HTML elements. More...
 
class  Node
 The base for all DOM nodes. More...
 
class  TagName
 The name(s) of the tag. More...
 
class  XmlNamespace
 Used to indicate which namespace a tag belongs to. Typically placed on some base class of all tags. More...
 
class  CharacterEntities
 Used to map entity names to their character. E.g. 'nbsp' to ' '. More...
 
class  DOMTokenList
 A live collection of DOM Tokens (always strings). More...
 
class  HTMLFormControlsCollection
 A collection of HTML form control elements. Very similar to HTMLCollection, only its namedItem method is slightly different. More...
 
interface  INodeList
 The NodeList interface. More...
 
class  RadioNodeList
 A list of radio nodes. Note that this is an element so it can be stored in a HTMLFormControlsCollection. More...
 
class  Document
 The interface for all XML-style documents. More...
 
class  DocumentFragment
 A document fragment. More...
 
class  DOMException
 Thrown whenever DOM actions fail. More...
 
class  DOMImplementation
 Provides a number of methods for performing operations that are independent of any particular instance of the DOM. More...
 
class  DOMParser
 A web API for parsing XML, HTML and SVG documents. Just a convenience wrapper over the HtmlParser. More...
 
class  DomEventListener
 Handler for Dom.Event events. More...
 
class  HashChangeEventListener
 Handler for HashChangeEvent events. More...
 
class  Event
 The root of all DOM events. More...
 
class  HashChangeEvent
 An event which triggers when the #hash of a location changes. More...
 
class  EventListener
 Describes either a nitro event or a delegate. More...
 
class  EventsSet
 A set of events for a given object (document or element). Used by addEventListener. More...
 
class  DispatchStack
 An event dispatch stack. Tracks the elements which an event is being dispatched to. More...
 
class  EventTarget
 An event target can receive events and have event handlers. More...
 
interface  IEventTarget
 An interface for something that can receive events. Typically used by custom objects (such as gameworld objects) to receive DOM events. More...
 
class  HtmlLexer
 A Html5 capable lexer. More...
 
struct  HtmlParserOptions
 Contains a number of options for the HTML parser. More...
 
class  HtmlTreeMode
 Possible insertation mode values. More...
 
class  LangLanguageElement
 This handles the language meta tags which are present in the global languages.xml file and ignored everywhere else. More...
 
class  LangElement
 This represents the language tag seen at the top of a language file. More...
 
class  LangVarElement
 Handles a variable tag within a language file. Variable tags define what a should be replaced with and essentially seperate layout or structure from the language. More...
 
class  FullVariableSet
 This set represents a set of variables in text, denoted by Implemented at e.g. UI.Variables/Speech.Variables. The event OnFind can be used to resolve a variable not found in either custom variables or the language (for localization) set. Nested variables (variables in a variables text) are evaluated at the point of replacement, not load. More...
 
class  LangDocument
 A Language document is used when loading localization files. More...
 
class  LanguageEvent
 
class  LanguageInfo
 Standard information about a particular language. More...
 
class  Language
 
class  LanguageGroup
 A particular group of variables within a language. E.g. Used by &GroupName.VariableName; with a LanguageGroup instance per language. More...
 
class  LanguageLoader
 Override this class to provide methods for loading language files. They may be delivered in many different ways because of this. More...
 
class  Text
 This class simply represents a global Language service. Things such as the UI/Speech sign on to the language change event and update themselves accordingly when it's fired. More...
 
class  VariableSet
 Represents a set of used for localization. More...
 
class  Location
 Represents a path to a file with a protocol. e.g. http://www.site.com/aFile.png The path may also be relative to some other path (aFile.png relative to http://www.site.com). More...
 
class  Log
 This class handles logging messages. When a message occurs, it fires an event so a specific application can handle them how it wishes. All logging can also be disabled with Dom.Log.Active. More...
 
interface  IParentNode
 The interface for all parent nodes. More...
 
class  Start
 Used to setup custom tags. More...
 
class  StringReader
 Treats a string of characters as a stream. This allows it to be read one character at a time. Attempting to read after the end of the stream will generate a Dom.StringReader.NULL character. More...
 
class  TagHandlers
 A global lookup of tag text to handler. TagHandlers are instanced globally and mapped to the tags they accept. When a tag is found, it is then instanced. One instance of a tag is created per element. More...
 
class  Comment
 
class  DocumentType
 The type of a HTML document. More...
 
class  Element
 This object represents any Markup Language (ML) tag such as html, sml, xml etc. More...
 
interface  ILangNode
 Contains . More...
 
class  MLNamespace
 Namespaces allow multiple XML elements using the same tag name to be present in a single document. https://www.w3.org/TR/2006/REC-xml-names-20060816/ More...
 
class  MLNamespaces
 Namespaces allow multiple XML elements using the same tag name to be present in a single document. https://www.w3.org/TR/2006/REC-xml-names-20060816/ More...
 
class  NodeFilter
 The various NodeFilter values. More...
 
class  NodeIterator
 Allows easy iteration through all elements in a node. More...
 
class  PropertyTextReader
 Reads properties/ attributes from a lexer. These are of the form propertyName="propertyValue", propertyName=value or singleProperty (i.e. no value). More...
 
class  SupportedTagMeta
 Stores information about a supported tag in a particular namespace. For example, info about 'div' in the 'xhtml' namespace. See MLNamespace.Tags (where these instances are stored). More...
 
class  CharacterData
 
class  TextNode
 
class  AttributeLookup
 A lookup is used to cache e.g. elements by ID. They hugely increase lookup speed and are automatically created for high traffic attributes (like ID). More...
 
class  AttributeLookupLink
 Sometimes more than one element has the same attribute. When that happens, they end up as a linked list. This is one of the links. More...
 
class  AttributeNode
 Represents an attribute on an element. Only ever used on request; not used internally. (You can actually delete this class and it's associated functions, which are in the folder alongside it). More...
 
class  PowerUILanguageLoader
 This class loads data for a language within Unity at runtime. The language must always be located in the Resources folder, under Resources/Languages/{path}. More...
 
class  HTMLOptionsCollection
 A collection of HTML option elements. More...
 

Enumerations

enum Dom.Gender

Enables player gender specific text, for example he or she. This represents a particular gender.

Enumerator
Boy 
Girl 
Either 
enum Dom.HtmlParseError : byte

A collection of HTML parse error codes.

Enumerator
EOF 

Unexpected end of file detected.

Null 

NULL character replaced by repl. character.

BogusComment 

Bogus comment.

AmbiguousOpenTag 

Ambiguous open tag.

TagClosedWrong 

The tag has been closed unexpectedly.

ClosingSlashMisplaced 

The closing slash has been misplaced.

UndefinedMarkupDeclaration 

Undefined markup declaration found.

CommentEndedWithEM 

Comment ended with an exclamation mark.

CommentEndedWithDash 

Comment ended with a dash.

CommentEndedUnexpected 

Comment ended with an unexpected character.

TagCannotBeSelfClosed 

The given tag cannot be self-closed.

EndTagCannotBeSelfClosed 

End tags can never be self-closed.

EndTagCannotHaveAttributes 

End tags cannot carry attributes.

CaptionNotInScope 

No caption tag has been found within the local scope.

SelectNotInScope 

No select tag has been found within the local scope.

TableRowNotInScope 

No table row has been found within the local scope.

TableNotInScope 

No table has been found within the local scope.

ParagraphNotInScope 

No paragraph has been found within the local scope.

BodyNotInScope 

No body has been found within the local scope.

BlockNotInScope 

No block element has been found within the local scope.

TableCellNotInScope 

No table cell has been found within the local scope.

TableSectionNotInScope 

No table section has been found within the local scope.

ObjectNotInScope 

No object element has been found within the local scope.

HeadingNotInScope 

No heading element has been found within the local scope.

ListItemNotInScope 

No list item has been found within the local scope.

FormNotInScope 

No form has been found within the local scope.

ButtonInScope 

No button has been found within the local scope.

NobrInScope 

No nobr element has been found within the local scope.

ElementNotInScope 

No element has been found within the local scope.

CharacterReferenceWrongNumber 

Character reference found no numbers.

CharacterReferenceSemicolonMissing 

Character reference found no semicolon.

CharacterReferenceInvalidRange 

Character reference within an invalid range.

CharacterReferenceInvalidNumber 

Character reference is an invalid number.

CharacterReferenceInvalidCode 

Character reference is an invalid code.

CharacterReferenceNotTerminated 

Character reference is not terminated by a semicolon.

CharacterReferenceAttributeEqualsFound 

Character reference in attribute contains an invalid character (=).

ItemNotFound 

The specified item has not been found.

EncodingError 

The encoding operation (either encoded or decoding) failed.

DoctypeUnexpectedAfterName 

Doctype unexpected character after the name detected.

DoctypePublicInvalid 

Invalid character in the public identifier detected.

DoctypeInvalidCharacter 

Invalid character in the doctype detected.

DoctypeSystemInvalid 

Invalid character in the system identifier detected.

DoctypeTagInappropriate 

The doctype tag is misplaced and ignored.

DoctypeInvalid 

The given doctype tag is invalid.

DoctypeUnexpected 

Doctype encountered unexpected character.

DoctypeMissing 

The doctype tag is missing.

NotationPublicInvalid 

The given public identifier for the notation declaration is invalid.

NotationSystemInvalid 

The given system identifier for the notation declaration is invalid.

TypeDeclarationUndefined 

The type declaration is missing a valid definition.

QuantifierMissing 

A required quantifier is missing in the provided expression.

DoubleQuotationMarkUnexpected 

The double quotation marks have been misplaced.

SingleQuotationMarkUnexpected 

The single quotation marks have been misplaced.

AttributeNameInvalid 

The attribute's name contains an invalid character.

AttributeValueInvalid 

The attribute's value contains an invalid character.

AttributeNameExpected 

The beginning of a new attribute has been expected.

AttributeDuplicateOmitted 

The attribute has already been added.

TagMustBeInHead 

The given tag must be placed in head tag.

TagInappropriate 

The given tag is not appropriate for the current position.

TagCannotEndHere 

The given tag cannot end at the current position.

TagCannotStartHere 

The given tag cannot start at the current position.

FormInappropriate 

The given form cannot be placed at the current position.

InputUnexpected 

The given input cannot be placed at the current position.

TagClosingMismatch 

The closing tag and the currently open tag do not match.

TagDoesNotMatchCurrentNode 

The given end tag does not match the current node.

LineBreakUnexpected 

This position does not support a linebreak (LF, FF).

HeadTagMisplaced 

The head tag can only be placed once inside the html tag.

HtmlTagMisplaced 

The html tag can only be placed once as the root element.

BodyTagMisplaced 

The body tag can only be placed once inside the html tag.

ImageTagNamedWrong 

The image tag has been named image instead of img.

TableNesting 

Tables cannot be nested.

IllegalElementInTableDetected 

An illegal element has been detected in a table.

SelectNesting 

Select elements cannot be nested.

IllegalElementInSelectDetected 

An illegal element has been detected in a select.

FramesetMisplaced 

The frameset element has been misplaced.

HeadingNested 

Headings cannot be nested.

AnchorNested 

Anchor elements cannot be nested.

TokenNotPossible 

The given token cannot be inserted here.

CurrentNodeIsNotRoot 

The current node is not the root element.

CurrentNodeIsRoot 

The current node is the root element.

TagInvalidInFragmentMode 

This tag is invalid in fragment mode.

FormAlreadyOpen 

There is already an open form.

FormClosedWrong 

The form has been closed wrong.

BodyClosedWrong 

The body has been closed wrong.

FormattingElementNotFound 

An expected formatting element has not been found.

enum Dom.HtmlParseMode : byte

Defines the different tokenization content models.

Enumerator
PCData 

Initial state: Parsed Character Data (characters will be parsed).

RCData 

Optional state: Raw character data (characters will be parsed from a special table).

Plaintext 

Optional state: Just plain text data (chracters will be parsed matching the given ones).

Rawtext 

Optional state: Rawtext data (characters will not be parsed).

Script 

Optional state: Script data.

enum Dom.ImplicitEndMode : int

Defines the different tokenization content models.

Enumerator
None 

No implicit ends.

Normal 

Closes in normal and thorough modes.

Thorough 

Closes in thorough mode only.

Enables player gender specific text, for example he or she. This represents a particular gender.

Enumerator
Preserve 

Whitespaces are preserved in the output.

Normal 

Sequences of spaces will be collapsed into one.

Delegates

delegate void Dom.DomEventDelegate ( Event  e)
delegate void Dom.GroupResolveEvent ( string  variableName,
LanguageTextEvent  onResolved 
)

Used when diverting a group. E.g. &items.1.name; - the group 'items' can be diverted so this variable can be loaded in a custom way.

delegate void Dom.HashChangeEventDelegate ( HashChangeEvent  e)
delegate void Dom.LanguageChange ( string  code)

An event called when the language is changed.

Parameters
codeThe new language code.
delegate void Dom.LanguageEventDelegate ( LanguageEvent  e)

Called when a group of variables has been loaded.

delegate void Dom.LanguageTextEvent ( string  result)
delegate ushort Dom.NodeFilterDelegate ( Node  node)

Delegate used by acceptNode().

delegate void Dom.OnLogEvent ( string  text)

The delegate used when Dom logs an event. It's used by Dom.Log.Onlog.

delegate void Dom.TextModifierChange ( )

An event called when any of the modifiers (such as gender) changes.