Difference between revisions of "TES5Edit Scripting Functions"
Jump to navigation
Jump to search
m
sorted the table
imported>ThreeTen (→TES5Edit Scripting Functions: - If someone can sort these that would be AWESOME!) |
imported>Egocarib m (sorted the table) |
||
| Line 59: | Line 59: | ||
| scope="row" | <b>Assigned</b> || boolean || element : IwbElement || Returns true if the element is not nil. Else returns false. | | scope="row" | <b>Assigned</b> || boolean || element : IwbElement || Returns true if the element is not nil. Else returns false. | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b>BuildRef</b> || || file : IwbFile || Will build and update ReferencedBy() data for IwbMainRecord's housed inside of files created via AddNewFile(). | |||
|- align="left" style="background-color: #EEEEEE" | |||
| scope="row" | <b>CanContainFormIDs</b> || boolean || element : IwbElement || | | scope="row" | <b>CanContainFormIDs</b> || boolean || element : IwbElement || | ||
|- align="left" style="background-color: #F8F8F8" | |||
| scope="row" | <b>CanMoveDown</b> || boolean || element : IwbElement || Checks if an element can by moved down a list to a higher index | |||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>CanMoveUp</b> || boolean || element : IwbElement || Checks if an element can be moved up a list to a lower index | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ChangeFormSignature</b> || || record : IwbMainRecord , signature : TwbSignature || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>Check</b> || string || element : IwbElement || Used in the "Check For Errors" script. | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ChildGroup</b> || IwbGroupRecord || record : IwbMainRecord || Use on a record like CELL or WRLD to return the group of records stored within it. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ChildrenOf</b> || IwbMainRecord || group : IwbGroupRecord || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>CleanMasters</b> || || file : IwbFile || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>CompareExchangeFormID</b> || boolean || mainrecord : IwbMainRecord , oldFormID : Cardinal , aNewFormID : Cardinal || Switches FormID references on mainrecord from oldFormID to aNewFormID. | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ConflictAllForMainRecord</b> || TConflictThis || record : IwbMainRecord || Gets the ConflictThis argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums) | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ConflictAllForNode</b> || TConflictThis || node : IwbElement || Gets the ConflictAll argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums) | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ConflictThisForMainRecord</b> || TConflictThis || record : IwbMainRecord || Gets the ConflictThis argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums) | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ConflictThisForNode</b> || TConflictThis || node : IwbElement || Gets the ConflictAll argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums) | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ContainingMainRecord</b> || IwbMainRecord || element : IwbElement || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>DefType</b> || TwbDefType || element : IInterface || returns the IwbElement::DefType (see dtXxxx enums) | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b>ElementAssign</b> || IwbElement || container : IwbContainer , aInder : integer, [element : IwbElement], aOnlySK : boolean || Copy the contents of one element into a container element | | scope="row" | <b>ElementAssign</b> || IwbElement || container : IwbContainer , aInder : integer, [element : IwbElement], aOnlySK : boolean || Copy the contents of one element into a container element | ||
; container | ; container | ||
| Line 100: | Line 102: | ||
Sample: there is a script to copy VMAD subrecords "Skyrim - Copy VMAD subrecord.pas" | Sample: there is a script to copy VMAD subrecords "Skyrim - Copy VMAD subrecord.pas" | ||
|- align="left" style="background-color: #EEEEEE" | |||
| scope="row" | <b>ElementByIndex</b> || IwbElement || container : IwbContainer , index : integer || Gets an element in the container by index | |||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ElementByName</b> || IwbElement || container : IwbContainer , name : string || Gets an element in the container by name | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ElementByPath</b> || IwbElement || container : IwbContainer , path : string || Gets an element in the container by path | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ElementBySignature</b> || IwbElement || container : IwbContainer , signature : string || Gets an element in the container by its signature | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ElementCount</b> || integer || container : IwbContainer || Returns the number of elements in a container | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ElementExists</b> || boolean || container : IwbContainer , name : string || Checks if the name of the element already exist in the container | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ElementType</b> || TwbElementType || element : IwbElement || Returns the ElementType of the element | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>Equals</b> || boolean || element1 : IwbElement , element2 : IwbElement || Compares both elements by their ElementID | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>FileByIndex</b> || IwbFile || index : integer || Gets the file at the specified index | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>FileByLoadOrder</b> || IwbFile || loadorder : integer || Gets the file at the specified load order | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>FileFormIDtoLoadOrderFormID</b> || cardinal || file : IwbFile , formid : string/cardinal || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>FindChildGroup</b> || IwbGroupRecord || group : IwbGroupRecord , aType : integer , aMainRecord : IwbMainRecord || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>FixedFormID</b> || cardinal || aMainRecord : IwbMainRecord || Returns the local FormID of the record (so local records will not have a load-order prefix e.g. 08FFFFFF -> 00FFFFFF) | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>FormID</b> || cardinal || aMainRecord : IwbMainRecord || Obtains the FormID of the record | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>FullPath</b> || string || element : IwbElement || Gives the full path, all the way down to file, of the input element | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>GetContainer</b> || IwbContainer || element : IwbElement || Gets the container of the element | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>GetEditValue</b> || string || element : IwbElement || Gets the element's value represented as text | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>GetElementEditValues</b> || string || element : IwbElement , name : string || Gets the element's value represented as text | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>GetElementNativeValues</b> || variant || element : IwbElement , name : string || Gets the element's native value | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>GetFile</b> || IwbFile || element : IwbElement || Gets the file that defines the element | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>GetFileName</b> || string || file : IwbFile || Obtains the filename of the plugin file | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>GetFormVersion</b> || cardinal || mainrecord : IwbMainRecord || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>GetIsDeleted</b> || boolean || mainrecord : IwbMainRecord || Indicates if the record has been deleted | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>GetIsESM</b> || boolean || file : IwbFile || Indicates if the plugin is an ESM file | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>GetIsInitiallyDisabled</b> || boolean || mainrecord : IwbMainRecord || Returns the value of the initially disabled flag on the specified record as a boolean | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>GetIsPersistent</b> || boolean || mainrecord : IwbMainRecord || Returns the value of the persistent flag on the specified record as a boolean | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>GetIsVisibleWhenDistant</b> || boolean || mainrecord : IwbMainRecord || Returns the value of the visible when distant flag on the specified record as a boolean | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>GetLoadOrder</b> || cardinal || file : IwbFile || Gets the global load order of the file | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>GetLoadOrderFormID</b> || cardinal || mainrecord : IwbMainRecord || Obtains the FormID with the current load order applied | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>GetNativeValue</b> || variant || element : IwbElement || Gets the element's native value | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>GroupBySignature</b> || || file : IwbFile , signature : string || Selects a group in a file by its signature | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>GroupLabel</b> || cardinal || group : IwbGroupRecord || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>GroupType</b> || integer || group : IwbGroupRecord || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>HasGroup</b> || boolean || file : IwbFile , signature : string || Checks if a file has a group by the group's signature | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>HasMaster</b> || boolean || file : IwbFile , signature : string || Returns true if the file has a master file defined | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>IndexOf</b> || integer || container : IwbContainer , element : IwbElement || Gets the index of the element inside the collection | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>InsertElement</b> || || container : IwbContainer , position : integer , element : IwbElement || Inserts an existing element inside a collection by position | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>IsEditable</b> || boolean || element : IwbElement || Returns true if the record can be edited by TES5Edit (false for Bethesda master files) | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>IsInjected</b> || boolean || element : IwbElement || Returns true if the record has been injected into another file | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>IsMaster</b> || boolean || record : IwbMainRecord || Returns true if the record is not an override for an already existing record | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>IsWinningOverride</b> || boolean || record : IwbMainRecord || Checks whether or not the record is the highest override loaded | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>JumpTo</b> || TConflictThis || record : IwbMainRecord , backward : boolean || Selects the specified record | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>LastElement</b> || IwbElement || container : IwbContainer || Obtains the last element in the collection | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>LinksTo</b> || IwbElement || element : IwbElement || Obtains the referenced element | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>LoadOrderFormIDtoFileFormID</b> || cardinal || file : IwbFile , aFormID : cardinal || Converts a FormID from the LoadOrder to the File Format. This means removing the formID prefix from local formIDs. | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>MainRecordByEditorID</b> || IwbMainRecord || group : IwbGroupRecord || Does not work for every case because it's inefficient | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>Master</b> || IInterface || record : IwbMainRecord || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>MasterByIndex</b> || IInterface || file : IwbFile , index : integer || Returns the master file at the specified index from the specified file | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>MasterCount</b> || cardinal || file : IwbFile || Returns the number of master files the specified file requires | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>MasterOrSelf</b> || IwbMainRecord || record : IwbMainRecord || Returns the master record for the given record when used on override records | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>MoveDown</b> || || element : IwbElement || Moves the element down (if the element is in a dtSubRecordArray or dtArray) | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>MoveUp</b> || || element : IwbElement || Moves the element up (if the element is in a dtSubRecordArray or dtArray) | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>Name</b> || || element : IwbElement || Obtains the name of the element | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>NifTextureList</b> || || tbsOpenResource : TBytesStream, slTextures : TStrings || Used to grab the file names of all related textures belonging to a nif file and adds it to slTextures. (Ex. NifTextureList(ResourceOpendata(",'meshes\effects\plants\floradeathbell01.nif'), slTextures); will try and find floradeathbell01.nif as a loose file inside of your data folder (or winning loose file for Mod Organizer users) and add all related textures to slTextures. slTextures is formatted so it can be used as aFileName for any other Resource-Related Tes5Edit functions. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b>OverrideByIndex</b> || IwbMainRecord || record : IwbMainRecord , index : integer || Gives the overriding record associated with the provided index | | scope="row" | <b>OverrideByIndex</b> || IwbMainRecord || record : IwbMainRecord , index : integer || Gives the overriding record associated with the provided index | ||
| Line 235: | Line 239: | ||
| scope="row" | <b>RemoveFilter</b> || || || Removes all Mod filters. Useful for visually correcting the contents of a file that has had records/GRUPs removed via RemoveNode. | | scope="row" | <b>RemoveFilter</b> || || || Removes all Mod filters. Useful for visually correcting the contents of a file that has had records/GRUPs removed via RemoveNode. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b>ResourceContainerList</b> || || slContainers : TwbFastStringList || Will fill slContainers with the full filename (directory+name) of all loaded BSA files. (note: tes5edit scripts use TwbFastStringList, but TStringList will work as well) | |||
|- align="left" style="background-color: #F8F8F8" | |||
| scope="row" | <b>ResourceCopy</b> || || container : IwbContainer , fileName : string , pathOut : string , containerIndex : integer || | | scope="row" | <b>ResourceCopy</b> || || container : IwbContainer , fileName : string , pathOut : string , containerIndex : integer || | ||
|- align="left" style="background-color: #EEEEEE" | |||
| scope="row" | <b>ResourceCount</b> || cardinal || container : IwbContainer , aFileName : string , containers : TStrings || | |||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ResourceExists</b> || boolean || container : IwbContainer , aFileName : string || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ResourceList</b> || || container : IwbContainer , aContainerName : string , containers : TStrings || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ResourceOpenData</b> || TBytesStream || aContainerName: String : String, aFileName : String || aFileName should be formatted similar to the other Resource-oriented Tes5edit scripts. aContainerName should be filled with a string generated by the function ResourceContainerList. Should only be used in conjunction with NifTextureList as ResourceCopy removes any other need for this function | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b>ReverseElements</b> || || container : IwbContainer || Reverses the order of a list of elements in a container | | scope="row" | <b>ReverseElements</b> || || container : IwbContainer || Reverses the order of a list of elements in a container | ||
| Line 280: | Line 288: | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b>WinningOverride</b> || IwbMainRecord || record : IwbMainRecord || Will return the winning override record | | scope="row" | <b>WinningOverride</b> || IwbMainRecord || record : IwbMainRecord || Will return the winning override record | ||
|} | |} | ||