1 Interface
- 1.1 addChildCategory
- 1.2 addHolder
- 1.3 createChild
- 1.4 delete
- 1.5 getCategory
- 1.6 getChild
- 1.7 getChildCategories
- 1.8 getChildCount
- 1.9 getChildList
- 1.10 getChildren
- 1.11 getDefaultChildCategory
- 1.12 getHolders
- 1.13 getModule
- 1.14 getName
- 1.15 getNodeName
- 1.16 getOwner
- 1.17 getParent
- 1.18 getPath
- 1.19 getRulesetVersion
- 1.20 getText
- 1.21 getType
- 1.22 getValue
- 1.23 getVersion
- 1.24 isEmpty
- 1.25 isIntact
- 1.26 isOwner
- 1.27 isPublic
- 1.28 isReadOnly
- 1.29 isStatic
- 1.30 onChildAdded
- 1.31 onChildDeleted
- 1.32 onChildUpdate
- 1.33 onDelete
- 1.34 onIntegrityChange
- 1.35 onObserverUpdate
- 1.36 onUpdate
- 1.37 removeAllHolders
- 1.38 removeChildCategory
- 1.39 removeHolder
- 1.40 revert
- 1.41 setCategory
- 1.42 setDefaultChildCategory
- 1.43 setPublic
- 1.44 setStatic
- 1.45 setValue
- 1.46 updateChildCategory
- 1.47 updateVersion

The campaign database tree contains the data from window controls and data sheets. The database exists as a tree format series of nodes, represented by databasenode objects. Each node (except the root nodes) has a parent, and a number of child nodes, as well as a name string. The database is preserved between sessions.

Each node has a type, with all the intermediate nodes having the "node" type, and the leaf nodes having a type based on the data in the leaf node.

Creating window instances and controls bound to the database will automatically create corresponding nodes in the database. Using the functions of this object, it is possible to also create new nodes and check for their existence explicitly.

Database node identifier strings

Many contexts in which node names are specified also accept database node identifier strings. These can be used to refer to a node possibly outside the current level (i.e. on a level below individual entries in an entry in a windowlist).

Depending on the context where the identifiers are used, they can be either absolute or relative. Absolute contexts look for the specified node under the root of the database. The most common uses for absolute contexts are windowclass and windowlist data sources. Relative contexts look for the node under the current data source (which is context dependent). A common example of a relative context is the data source for a window control, which tries to find the named node under the window data source.

Absolute contexts may have a data source under which a relative lookup could be performed. In such a case, a dot character at the beginning of the identifier will cause a relative lookup instead. An example of this is the windowlist data source. Identifiers in a relative context may also include the dot character, but it will be synonymous with the case without it.

Adding further dot characters after the first to the beginning of the identifier will cause a corresponding number of steps upwards in the tree structure. Steps deeper into the tree can be specified by separating successive nodes with the dot character.

Module data

The data for each active module resides in its own data base tree. This allows more flexible data preparation for module design, and guarantees that interlinking data inside modules and between modules works predictably.

Global level node listings (such as those found in ordinary windowlist listings) include module data from the corresponding module trees as well, if such data is present. E.g. a windowlist that takes its data from the "images" node would also receive all child nodes of any "image" nodes under all activated modules.

To access a particular node in the module data bases, a special identifier string syntax is used. Node identifier strings for module data are formed by following the procedure above, prefixing the identifier with the at character '@' and following with the complete name of the module.

Interface

addChildCategory

function addChildCategory(category)

Adds a child category for this data base node.

Parameters

category (table (or string))
New category information (or name)

addHolder

function addHolder(username, owner)

This function adds the specified user as a holder for this node and all child nodes. If the owner flag is set, the user will also be able to modify the contents of data nodes. In such a case, any existing ownership is revoked.

This function will only return valid values if running as the session host. Using User.isHost to confirm this is recommended.

Parameters

username (string)
The username of the user gaining the status

owner (boolean)
If true, the user will also be flagged the owner of the node

createChild

function createChild([name], [type])

Create, or if it already exists fetch, the specified child node under the current node.

Parameters

name (string) [optional]
A relative node identifier specifying the child node to find. If this parameter is omitted, a new unique node name will be generated.

type (string) [optional]
The type of node to create. If this parameter is omitted, an intermediate node will be created. Leaf nodes can be of types "number", "string", "formattedtext", "image", "dice" or "windowreference".

Return values

(databasenode)
If the node already exists, the return value is a reference to that node. If it was created, a reference to the created node is returned. If there was an error, returns nil.

delete

Delete the database node, removing it from the database tree and deleting all child nodes. Any window instances using this node as their data source will be closed.

getCategory

Gets the category information for this data base node.

Return values

(table)
Category information for specified node, including the following fields (name, mergeid, base, decal). The name field is the name of the category. The merge ID field is a value that can be specified for each module to allow multiple modules to be listed in a single category. The base field is a number defining the index of the background tab to use when displaying the category. The decal field is a number defining the index of the decal to use when displaying the category. The combination of all four entries defines a unique category.

getChild

Fetches the specified child node under the current node.

Parameters

name (string)
A relative node identifier specifying the child node to find

Return values

(databasenode)
A databasenode object representing the node, or nil if the node could not be found

getChildCategories

Gets the child categories for this data base node.

Return values

(table)
An integer-indexed table of category records. Each category record is a table with the following fields (name, mergeid, base, decal).

getChildCount

Get the number of child nodes belonging to this node.

Return values

(number)
The number of child nodes

getChildList

Get all the child nodes of this node via numerical key.

Return values

(table)
The child nodes are returned as databasenode objects in a table with numerical keys.

getChildren

Get all the child nodes of this node via name key.

Return values

(table)
The child nodes are returned as databasenode objects in a table with keys corresponding to the names of the child nodes.

getDefaultChildCategory

Gets the default child category for this data base node. When new child nodes are created under this node, the default category is given to those child nodes.

Parameters

category (string)
Category to set as default (or category name)

Return values

(string)
The name of the default category assigned to child nodes under the specified node.

getHolders

This function returns a list of all users registered as holders of this node. Holders will be notified of changes to the node value. The holder list is automatically updated as a result of window sharing operations.

This function will only return valid values if running as the session host. Using User.isHost to confirm this is recommended.

Return values

(table)
Returns an integer indexed table containing the usernames of all registered holders for this node.

getModule

Retrieves the name of the module the data base node was loaded from.

Return values

(string)
Returns the name of the module the node was loaded from, or nil if the node was not loaded from a module

getName

Get the name of this node.

Return values

(string)
Returns the string containing the node name

getNodeName

Get the dot separated complete node name, from the root node to the current node.

Return values

(string)
Returns the dot separated complete node name

getOwner

Only valid on host.

This function returns the username of the client acting as the current owner of the node. Only the GM or the node owner can alter the value of the database node contents.

Return values

(string)
Returns the username of the user owning the node, or nil if no owner is registered.

getParent

Fetches the parent of the current node.

Return values

(databasenode)
A databasenode object representing the parent node, or nil if the current node is a root level node

getPath

Returns the path of this node, appended with any path parameters provided. The module portion of the path returned will be inherited from the calling node. (if any)

Database paths are of the form: [node].(...).[node][@Module Name]

where there can be any number of valid XML tag names concatenated by periods to form the main path and the at symbol and module name is optional.

Parameters

value (...) [optional]
One or more strings to be appended to database path returned

Return values

(string)
The string representation of the databasenode path

getRulesetVersion

Returns the release number of the ruleset used to save the data, as defined by the release attribute of the database definition root element. The value is defined as a major and a minor version number.

Any database nodes not directly created as a result of a load operation will have the value of the current ruleset release.

Return values

(number)
The major version number(number)
The minor version number(table)
A table containing the major version number of each ruleset layer, where the key is the name of the ruleset layer.(table)
A table containing the minor version number of each ruleset layer, where the key is the name of the ruleset layer.

getText

Returns a textual representation of the value contained in the database node. If the node type is not string, number or formattedtext, then nil will be returned.

Return values

(string)
Returns the string value of the database node value.

getType

Get the string identifying the type of this node. The possible values are "node" (representing an intermediate node), "number", "string", "formattedtext", "image", "dice" and "windowreference".

Return values

(string)
The type string

getValue

Returns the value contained in the database node. The return value(s) vary depending on the type of the node.

Return values

(...)
Returns data contained in the database node

getVersion

Returns the version number of the FG client last used to save the data, or since the last updateVersion call.

Return values

(number)
The major version number(number)
The minor version number

isEmpty

Returns whether the database node is empty.

Certain database value types will always return false. (image values)

Return values

(boolean)
Whether the database node is empty

isIntact

Database nodes loaded from modules are modifiable unless marked static. These modifications are local to a campaign, and the node may be reverted back to its original state. This function may be used to check if such a node has any changes applied.

Non-module campaign data base nodes always return false.

Return values

(boolean)
Returns true if the node has been modified, false if it is identical to the module contents

isOwner

This function returns whether the current user can modify the node. Only the GM or the node owner can alter the value of the database node contents.

Return values

(boolean)
Returns true if the user is the GM or owns the node, or false otherwise.

isPublic

Returns whether a node is public.

Public nodes are available for viewing by any user, whether GM or player. A node can still be shared with specific players without being made public.

Return values

(string)
Returns true if the node is public, false if it is not

isReadOnly

Determines whether a database node can be edited. Reasons for database nodes to be non-editable include: nodes marked as static, nodes from client or common modules, nodes not owned by client (host owns all nodes)

Return values

(boolean)
Returns true if the node is not editable, false otherwise

isStatic

Database nodes may be flagged as static, disabling value editing completely. This flag is generally used for non-alterable reference data loaded from rules modules. This function can be used to check if a node is part of the static content.

Return values

(boolean)
Returns true if the node is static, false otherwise

onChildAdded

A handler function that will be called when a new child node is added to this node.

Parameters

source (databasenode)
A databasenode object reference identifying the node receiving a new child node

child (databasenode)
A databasenode object reference identifying the child node added