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
Alch AsAlch() Converts this form to a Potion form or returns null if this form is not a Potion form.
Ammo AsAmmo() Converts this form to an Ammo form or returns null if this form is not an Ammo form.
Armo AsArmo() Converts this form to an Armor form or returns null if this form is not an Armor form.
Cobj AsCobj() Converts this form to a Constructible Object form or returns null if this form is not a Constructible Object form.
Coll AsColl() Converts this form to a Collision Layer form or returns null if this form is not a Collision Layer form.
Ench AsEnch() Converts this form to an Enchantment form or returns null if this form is not an Enchantment form.
Equp AsEqup() Converts this form to an Equipment Type form or returns null if this form is not an Equipment Type form.
Expl AsExpl() Converts this form to an Explosion form or returns null if this form is not an Explosion form.
Flst AsFlst() Converts this form to a Form List form or returns null if this form is not a Form List 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.
Ipds AsIpds() Converts this form to a Impact Data Set form or returns null if this form is not an Impact Data Set form.
Kywd AsKywd() Converts this form to a Keyword form or returns null if this form is not a Keyword form.
Ligh AsLigh() Converts this form to a Light form or returns null if this form is not a Light form.
Matt AsMatt() Converts this form to a Material form or returns null if this form is not a Material form.
Mgef AsMgef() Converts this form to a Magic Effect form or returns null if this form is not a Magic Effect form.
Proj AsProj() Converts this form to a Projectile form or returns null if this form is not a Projectile form.
Race AsRace() Converts this form to a Race form or returns null if this form is not a Race 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.
Spel AsSpel() Converts this form to a Spell form or returns null if this form is not a Spell 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.
Txst AsTxst() Converts this form to a Texture Set form or returns null if this form is not a Texture Set form.
Weap AsWeap() Converts this form to a Weapon form or returns null if this form is not a Weapon 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