Packages
 Comm
 DB
 Debug
 Extension
 Input
 Interface
 Module
 Token
 User

Objects
 bitmapwidget
 databasenode
 dragdata
 textbasecontrol
 textwidget
 tokeninstance
 widget
 widgetcontainer
 windowcontrol
 windowinstance

Controls
 buttoncontrol
 buttonfield
 categoryselectioncontrol
 chatentry
 chatwindow
 databasecontrol
 diecontrol
 diefield
 formattedtextcontrol
 formattedtextfield
 genericcontrol
 imagecontrol
 numbercontrol
 numberfield
 portraitselectioncontrol
 scrollbarcontrol
 scrollercontrol
 stringcontrol
 stringfield
 subwindow
 tokenbag
 tokencontrol
 tokenfield
 windowlist
 windowreferencecontrol
 windowreferencefield

Assets and Settings
 announcement
 categoryselectionsettings
 characterdbroot
 customdie
 description
 desktopframe
 die
 diebox
 distance
 font
 framedef
 hotkeybar
 icon
 imageupdatefolder
 imagesettings
 importinfo
 importruleset
 includefile
 panel
 pollbox
 portraitset
 properties
 replaces
 script
 string
 template
 textsettings
 tokenroot
 tooltip
 windowclass



This definition is used in the extension.xml file to specify the properties of an extension.

There are several properties which can influence availability and load order. These tags take priority in this order: ruleset, exclusiongroup, dependency, loadorder.

The ruleset property determines whether the extension is shown for a given campaign based on the ruleset used. If the minrelease and/or maxrelease subtags are specified, and the ruleset version does not match, then the extension will be shown as broken on the launcher screen, and not be selectable.

If the exclusion group property is defined, only the first extension within a given exclusion group will be loaded. All other extensions with the same exclusion group property will be skipped.

If the dependency property is defined, the extension on which the current extension is dependent will always be loaded first. If the extension on which the current extension is dependent is not available and selected, then this extension will not be loaded.

The loading order for extensions is defined by starting with the largest loadorder property for an extension down to the lowest loadorder property. If two extensions have the same load order value, then they are loaded in alphabetical order. If no load order value is defined, then zero is assumed.



Definition

<properties >
<name > ... </name> Extension display name
<version > ... </version> Optional. Extension version
<author > ... </author> Optional. Extension author
<description > ... </description> Optional. Text describing what the extension does
<ruleset > The ruleset for which this extension can be used. More than one ruleset tag can be defined.
<minrelease > ... </minrelease> Minimum ruleset version allowed for this extension and ruleset combination
<maxrelease > ... </maxrelease> Maximum ruleset version allowed for this extension and ruleset combination
</ruleset>
<exclusiongroup > ... </exclusiongroup> Optional. Exclusion group to which the extension belongs.
<dependency > Optional. The name of the extension upon which this extension is dependent.
<minversion > ... </minversion> Minimum extension version for this dependency
<maxversion > ... </maxversion> Maximum extension version for this dependency
</dependency>
<loadorder > ... </loadorder> Optional. Positive number defining the order in which the extension should be loaded.
</properties>

'Fantasy Grounds' is a trademark of SmiteWorks Ltd. All other trademarks are the property of their respective owners.
© 2004-2010 SmiteWorks Ltd. ALL RIGHTS RESERVED.
Privacy policy