Form
Summary
Represents a form the type of which is either unknown, unsupported or unresolved. To convert an unknown form to a specific form use the appropriate extension method. Properties and methods provided by this class are available to all forms.
Properties
Name Description
string EditorId Gets or sets the Editor ID associated with this form.
uint FormId Gets the Form ID associated with this form.
Methods
Name Description
bool HasTag(string) Determines whether this form has been tagged with the specified text.
void Tag(string) Tags this form with the specified text.
Extension Methods
Name Description
Aoru AsAoru() Converts this form to a Activation Rule form or returns null if this form is not a Activation Rule form.
Flst AsFlst() Converts this form to a Form List form or returns null if this form is not a Form List form.
Gdry AsGdry() Converts this form to a God Reys form or returns null if this form is not a God Reys form.
Glob AsGlob() Converts this form to a Global Variable form or returns null if this form is not a Global Variable form.
Gmst AsGmst() Converts this form to a Game Setting form or returns null if this form is not a Game Setting form.
Imgs AsImgs() Converts this form to a Image Space form or returns null if this form is not an Image Space form.
Kywd AsKywd() Converts this form to a Keyword form or returns null if this form is not a Keyword form.
Rfct AsRfct() Converts this form to a Visual Effect form or returns null if this form is not a Visual Effect form.
Sndr AsSndr() Converts this form to a Sound form or returns null if this form is not a Sound form.
Spgd AsSpgd() Converts this form to a Shader Particle Geometry form or returns null if this form is not a Shader Particle Geometry form.
Stat AsStat() Converts this form to a Static form or returns null if this form is not a Static form.
Wthr AsWthr() Converts this form to a Weather form or returns null if this form is not a Weather form.
Remarks

When a variable refers to an unknown or generic form it means that only the common form properties and methods are available. In order to access all properties of the form the variable must be cast to the specific form using the appropriate extension method.

Unknow or generic forms can be retrieved via the Forms helper method Forms.Find() or by iterating a mixed FormCollection such as the collection of forms associated with a Form List form.

Unsupported forms are forms that have been loaded but the appliaction does not know anything about such form. Unsupported forms can be assigned to properties of supported forms or added to mixed FormCollection. Unsupported forms cannot be converted to a specific form.

Unresolved forms are threaded the same way unsupported forms are treated, except that their Editor ID is always null. Unresolved forms come about from references to forms that do not exist due to an error in a plugin, or because the tool deliberately skipped these forms while loading plugin. Saving plugin that reference unresolved forms will produce a warning, but will work as intended as long as the form really exists.

Return to: Index