Difference between revisions of "TES5Edit Scripting Functions"

Work in progress: To become the future home of scripting functions for TES5Edit. If you make scripts for TES5Edit please contribute to this page.

Work in progress: To become the future home of scripting functions for TES5Edit. If you make scripts for TES5Edit please contribute to this page.

The information in the table is not complete so please contribute by explaining these functions, their uses and by fixing mistakes in this information.

The information in the table is not complete so please contribute by explaining these functions, their uses and by fixing mistakes in this information.

=== TES5Edit Global Variables ===

=== TES5Edit Global Variables ===

     [[#IwbElement|IwbElement]]

     [[#IwbElement|IwbElement]]

      

      

     [[#IwbResource|IwbResource]]

     [[#IwbResource|IwbResource]]

     IwbResourceContainer

     IwbResourceContainer

      

      

     [[#Misc functions|Misc functions]]

     [[#Misc functions|Misc functions]]

==== Global functions ====

==== Global functions ====

! scope="col" style="background-color: #DDDDDD" | Description

! scope="col" style="background-color: #DDDDDD" | Description

{{TES5Edit function row|even

{{TES5Edit function row|even

   |Assigned|boolean|aeElement: IwbElement

   |Assigned|boolean|aeElement: IwbElement

   |An extension to Delphi's native [http://www.delphibasics.co.uk/RTL.asp?Name{{=}}Assigned Assigned] function: returns true if ''aeElement'' is not ''Nil'', and returns false otherwise.}}

   |An extension to Delphi's native [http://www.delphibasics.co.uk/RTL.asp?Name{{=}}Assigned Assigned] function: returns true if ''aeElement'' is not ''Nil'', and returns false otherwise.}}

   |ObjectToElement|IInterface|akObject

   |ObjectToElement|IInterface|akObject

   |If you have stored an IInterface inside of a TList or TStringList, you must call this function when retrieving the object from the list, i.e. <code>ObjectToElement(myList.Items[0])</code>.}}

   |If you have stored an IInterface inside of a TList or TStringList, you must call this function when retrieving the object from the list, i.e. <code>ObjectToElement(myList.Items[0])</code>.}}

   |FileByIndex|IwbFile|aiFile: integer

   |FileByIndex|IwbFile|aiFile: integer

   |See also: ''FileCount''.}}

   |See also: ''FileCount''.}}

   |FullPathToFilename|string|asFilename: string

   |FullPathToFilename|string|asFilename: string

   |Returns the full path to the filename ''asFilename''.}}

   |Returns the full path to the filename ''asFilename''.}}

   |EnableSkyrimSaveFormat||

   |EnableSkyrimSaveFormat||

   |As of xEdit 3.1.2, calling this function will corrupt saved plugins until xEdit is restarted.}}

   |As of xEdit 3.1.2, calling this function will corrupt saved plugins until xEdit is restarted.}}

   |GetRecordDefNames||akList: TStrings

   |GetRecordDefNames||akList: TStrings

   |Unverified: Modifies ''akList'' by adding entries based on the contents of the global ''wbRecordDefs''.}}

   |Unverified: Modifies ''akList'' by adding entries based on the contents of the global ''wbRecordDefs''.}}

   |wbFilterStrings||akListIn: TStrings;<br/> akListOut: TStrings;<br/> asFilter: String

   |wbFilterStrings||akListIn: TStrings;<br/> akListOut: TStrings;<br/> asFilter: String

   |Modifies ''akListOut'', adding every entry in ''akListIn'' that contains the substring ''asFilter''.}}

   |Modifies ''akListOut'', adding every entry in ''akListIn'' that contains the substring ''asFilter''.}}

   |wbRemoveDuplicateStrings||akList: TStringList

   |wbRemoveDuplicateStrings||akList: TStringList

   |Modifies ''akList'', removing any duplicate entries that it contains.}}

   |Modifies ''akList'', removing any duplicate entries that it contains.}}

   |Adds the specified file as a master for ''aeFile'', if it isn't already a master.}}

   |Adds the specified file as a master for ''aeFile'', if it isn't already a master.}}

{{TES5Edit function row|odd

{{TES5Edit function row|odd

   |CleanMasters||aeFile: IwbFile

   |CleanMasters||aeFile: IwbFile

   |Appears to find unnecessary files in ''aeFile''<nowiki/>'s master list and remove them, updating all form indices accordingly. Don't confuse this within "cleaning master files" as in "removing ITMs and UDRs from official DLCs." This function is used in "Skyrim - Book Covers Patch.pas".}}

   |Appears to find unnecessary files in ''aeFile''<nowiki/>'s master list and remove them, updating all form indices accordingly. Don't confuse this within "cleaning master files" as in "removing ITMs and UDRs from official DLCs." This function is used in "Skyrim - Book Covers Patch.pas".}}

   |FileFormIDtoLoadOrderFormID|cardinal|aeFile: IwbFile; aiFormID: cardinal

   |FileFormIDtoLoadOrderFormID|cardinal|aeFile: IwbFile; aiFormID: cardinal

   |Converts ''aiFormID'' from a form ID relative to ''aeFile''<nowiki/>'s master list (like that returned by ''FixedFormID'') to a load-order-relative form ID (like that returned by ''FormID''). See also: ''LoadOrderFormIDtoFileFormID''.}}

   |Converts ''aiFormID'' from a form ID relative to ''aeFile''<nowiki/>'s master list (like that returned by ''FixedFormID'') to a load-order-relative form ID (like that returned by ''FormID''). See also: ''LoadOrderFormIDtoFileFormID''.}}

   |FileWriteToStream||aeFile: IwbFile;<br/> akOutStream: TStream

   |FileWriteToStream||aeFile: IwbFile;<br/> akOutStream: TStream

   |Writes the contents of ''aeFile'' to ''akOutStream''. Used in "SaveAs.pas" to allow a user to save a loaded file under a new name; that script creates a TFileStream object and uses this function to write to it.}}

   |Writes the contents of ''aeFile'' to ''akOutStream''. Used in "SaveAs.pas" to allow a user to save a loaded file under a new name; that script creates a TFileStream object and uses this function to write to it.}}

   |GetFileName|string|aeFile: IwbFile

   |GetFileName|string|aeFile: IwbFile

   |Returns ''aeFile''<nowiki/>'s filename.}}

   |Returns ''aeFile''<nowiki/>'s filename.}}

   |GetIsESM|boolean|aeFile: IwbFile

   |GetIsESM|boolean|aeFile: IwbFile

   |Returns ''True'' if ''aeFile'' is flagged as an ESM. See also: ''SetIsESM''.}}

   |Returns ''True'' if ''aeFile'' is flagged as an ESM. See also: ''SetIsESM''.}}

   |GetLoadOrder|string|aeFile: IwbFile

   |GetLoadOrder|string|aeFile: IwbFile

   |Returns ''aeFile''<nowiki/>'s index in the load order, or -1 if called on something that is not an IwbFile.}}

   |Returns ''aeFile''<nowiki/>'s index in the load order, or -1 if called on something that is not an IwbFile.}}

   |GetNewFormID|cardinal|aeFile: IwbFile

   |GetNewFormID|cardinal|aeFile: IwbFile

   |Returns a new form ID, the same way that <code>Add(..., ..., True)</code> does.}}

   |Returns a new form ID, the same way that <code>Add(..., ..., True)</code> does.}}

   |GroupBySignature|IwbGroupRecord|aeFile: IwbFile;<br/> asSignature: string

   |GroupBySignature|IwbGroupRecord|aeFile: IwbFile;<br/> asSignature: string

   |If ''aeFile'' has a top-level group with the specified signature, that group is returned.}}

   |If ''aeFile'' has a top-level group with the specified signature, that group is returned.}}

   |HasGroup|boolean|aeFile: IwbFile;<br/> asSignature: string

   |HasGroup|boolean|aeFile: IwbFile;<br/> asSignature: string

   |Returns ''True'' if ''aeFile'' contains a top-level group with the specified signature.}}

   |Returns ''True'' if ''aeFile'' contains a top-level group with the specified signature.}}

   |HasMaster|boolean|aeFile: IwbFile;<br/> asMasterFilename: string

   |HasMaster|boolean|aeFile: IwbFile;<br/> asMasterFilename: string

   |Returns ''True'' if ''aeFile'' has a file with the name ''asMasterFilename'' as a master.}}

   |Returns ''True'' if ''aeFile'' has a file with the name ''asMasterFilename'' as a master.}}

   |LoadOrderFormIDtoFileFormID|cardinal|aeFile: IwbFile; aiFormID: cardinal

   |LoadOrderFormIDtoFileFormID|cardinal|aeFile: IwbFile; aiFormID: cardinal

   |Converts ''aiFormID'' from a load-order-relative form ID (like that returned by ''FormID'') to a form ID relative to ''aeFile''<nowiki/>'s master list (like that returned by ''FixedFormID''). See also: ''FileFormIDtoLoadOrderFormID''.}}

   |Converts ''aiFormID'' from a load-order-relative form ID (like that returned by ''FormID'') to a form ID relative to ''aeFile''<nowiki/>'s master list (like that returned by ''FixedFormID''). See also: ''FileFormIDtoLoadOrderFormID''.}}

   |MasterByIndex|IwbFile|aeFile: IwbFile;<br/> aiIndex: integer

   |MasterByIndex|IwbFile|aeFile: IwbFile;<br/> aiIndex: integer

   |Returns the ''aiIndex''-th master file for ''aeFile''.}}

   |Returns the ''aiIndex''-th master file for ''aeFile''.}}

   |MasterCount|cardinal|aeFile: IwbFile

   |MasterCount|cardinal|aeFile: IwbFile

   |Returns the number of master files that ''aeFile'' has.}}

   |Returns the number of master files that ''aeFile'' has.}}

   |RecordByEditorID|IwbMainRecord|aeFile: IwbFile;<br/> asEditorID: string

   |RecordByEditorID|IwbMainRecord|aeFile: IwbFile;<br/> asEditorID: string

   |Returns the [[Magic Effect|MGEF]] or [[Setting|GMST]] record in ''aeFile'' that has the specified editor ID. For all other record types, use something like <code>MainRecordByEditorID(GroupBySignature(f, 'ECZN'), 'RandomEncounterZone1')</code>.}}

   |Returns the [[Magic Effect|MGEF]] or [[Setting|GMST]] record in ''aeFile'' that has the specified editor ID. For all other record types, use something like <code>MainRecordByEditorID(GroupBySignature(f, 'ECZN'), 'RandomEncounterZone1')</code>.}}

   |RecordByFormID|IwbMainRecord|aeFile: IwbFile;<br/> aiFormID: integer;<br/> abAllowInjected: boolean

   |RecordByFormID|IwbMainRecord|aeFile: IwbFile;<br/> aiFormID: integer;<br/> abAllowInjected: boolean

   |Returns the main record in ''aeFile'' that has the specified form ID, or ''Nil'' if no records match. The form ID must be local to the file (see ''FixedFormID'').}}

   |Returns the main record in ''aeFile'' that has the specified form ID, or ''Nil'' if no records match. The form ID must be local to the file (see ''FixedFormID'').}}

   |RecordByIndex|IwbMainRecord|aeFile: IwbFile;<br/> aiIndex: integer

   |RecordByIndex|IwbMainRecord|aeFile: IwbFile;<br/> aiIndex: integer

   |Returns the ''aiIndex''-th record in ''aeFile''.}}

   |Returns the ''aiIndex''-th record in ''aeFile''.}}

   |RecordCount|cardinal|aeFile: IwbFile

   |RecordCount|cardinal|aeFile: IwbFile

   |Returns the number of records that ''aeFile'' has.}}

   |Returns the number of records that ''aeFile'' has.}}

   |SetIsESM||aeFile: IwbFile;<br/> abFlag: boolean

   |SetIsESM||aeFile: IwbFile;<br/> abFlag: boolean

   |Modifies the ESM flag for ''aeFile''. See also: ''GetIsESM''.}}

   |Modifies the ESM flag for ''aeFile''. See also: ''GetIsESM''.}}

   |SortMasters||aeFile: IwbFile

   |SortMasters||aeFile: IwbFile

   |Attempts to sort the masters for ''aeFile'' by their place in the current load order.}}

   |Attempts to sort the masters for ''aeFile'' by their place in the current load order.}}