Difference between revisions of "TES5Edit Scripting Functions"
Jump to navigation
Jump to search
m
sorted the table again :)
imported>ThreeTen |
imported>Egocarib m (sorted the table again :)) |
||
| Line 61: | Line 61: | ||
| 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>BaseRecord</b> || IwbMainRecord || element : IwbMainRecord || Used on REFR records to to grab the Base Form they are referencing, otherwise returns nil. | |||
|- align="left" style="background-color: #EEEEEE" | |||
| scope="row" | <b>BuildRef</b> || || file : IwbFile || Will build and update ReferencedBy() data for IwbMainRecord's housed inside of files created via AddNewFile(). | | 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: #F8F8F8" | |||
| scope="row" | <b>CanContainFormIDs</b> || boolean || element : IwbElement || | |||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | 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: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| 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: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ChangeFormSignature</b> || || record : IwbMainRecord , signature : TwbSignature || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>Check</b> || string || element : IwbElement || Used in the "Check For Errors" script. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| 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: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ChildrenOf</b> || IwbMainRecord || group : IwbGroupRecord || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>CleanMasters</b> || || file : IwbFile || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| 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: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| 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: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| 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: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| 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: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| 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: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ContainingMainRecord</b> || IwbMainRecord || element : IwbElement || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>DefType</b> || TwbDefType || element : IInterface || returns the IwbElement::DefType (see dtXxxx enums) | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>EditorID</b> || string || element : IwbElement || grabs the EditorID of element | ||
|- 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 | ||
| Line 213: | Line 217: | ||
| 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. | | 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>ObjectToElement</b> || IwbElement || slObjects : TObject || IInterface's added to TStringLists via sl.AddObject('string', iielement) will need to be changed back with this function. (ex. iinterfaceVar := ObjectToElement(sl.Objects[i])) | |||
|- align="left" style="background-color: #F8F8F8" | |||
| 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 | ||
|- align="left" style="background-color: #EEEEEE" | |||
| scope="row" | <b>OverrideCount</b> || cardinal || record : IwbMainRecord || Provides a value for the number of overrides there are for a given record | |||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>Path</b> || string || element : IwbElement || Returns the path of the specified element. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>RecordByEditorID</b> || IwbMainRecord || file : IwbFile , editorid : string || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>RecordByFormID</b> || IwbMainRecord || file : IwbFile , formid : integer , aAllowInjected : boolean || Will return the record with the specified FormID in the specified file, if it exists. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>RecordByIndex</b> || IwbMainRecord || file : IwbFile , index : integer || Returns the reocrd at the specified index in the specified file. | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>RecordCount</b> || cardinal || file : IwbFile || Returns a value corresponding to the number of records in a file | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ReferencedByCount</b> || cardinal || record : IwbMainRecord || Returns the number of records that reference the input record. | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ReferencedByIndex</b> || IwbMainRecord || record : IwbMainRecord , index : integer || Returns the IwbMainRecord reference to the given record at the entered index. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>Remove</b> || || element : IwbElement || Removes an element. | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>RemoveByIndex</b> || IwbElement || container : IwbContainer , index : integer , aMarkModified : boolean || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>RemoveElement</b> || IwbElement || container : IwbContainer , element : IwbElement || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>RemoveNode</b> || boolean || node : IwbElement || Removes the node from the file. Use this instead of Remove/RemoveElement to avoid errors when removing elements selected by and visible to the user. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | 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: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | 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: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ResourceCopy</b> || || container : IwbContainer , fileName : string , pathOut : string , containerIndex : integer || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ResourceCount</b> || cardinal || container : IwbContainer , aFileName : string , containers : TStrings || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>ResourceExists</b> || boolean || container : IwbContainer , aFileName : string || | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ResourceList</b> || || container : IwbContainer , aContainerName : string , containers : TStrings || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| 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: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ReverseElements</b> || || container : IwbContainer || Reverses the order of a list of elements in a container | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>SetEditValue</b> || || element : IwbElement , value : string || Sets the value of the element as string (you can set Form members by using their formID string as the second parameter of this function, e.g. '01A32FF8') | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>SetElementEditValues</b> || || container : IwbContainer , path : string , value : string || Sets the value as a string of the element by its path | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>SetElementNativeValues</b> || || container : IwbContainer , path : string , value : variant || Sets the native value of the element by its path | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>SetFormVersion</b> || || record : IwbMainRecord , version : integer || | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>SetIsDeleted</b> || || record : IwbMainRecord , value : boolean || Enables/disables deleted flag for a record | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>SetIsESM</b> || || file : IwbFile , value : boolean || Enables/disbles ESM flag for a file | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>SetIsInitiallyDisabled</b> || || record : IwbMainRecord , value : boolean || Enables/disables the initially disabled flag for a record. | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>SetIsPersistent</b> || || record : IwbMainRecord , value : boolean || Enables/disables the persistent flag for a record. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>SetIsVisibleWhenDistant</b> || || record : IwbMainRecord , value : boolean || Enables/disables the visible when distant flag for a record. | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>SetLoadOrderFormID</b> || || record : IwbMainRecord , loadOrderFormId : cardinal || Changes the 8-digit hexadecimal Form ID for a record | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>SetNativeValue</b> || || element : IwbElement , value : variant || Sets the native value of the element | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>ShortName</b> || string || element : IwbElement || Gets the short name of the element | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>Signature</b> || string || record : IwbMainRecord || Gets the signature of a record | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>SortKey</b> || string || element : IwbElement, aExtended: boolean || Outputs a string unique to the element entered. This can be used for sorting elements or for comparing them. E.g. You could compare the SortKey for two elements in records which override each other to see if they are different from each other. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>SortMasters</b> || || file : IwbFile || Attempts to sort the masters for a file by their load order | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| scope="row" | <b> | | scope="row" | <b>wbCopyElementToFile</b> || IwbElement || element : IwbElement , file : IwbFile , aAsNew : boolean , aDeepCopy : boolean || Copies an IwbMainRecord, IwbGroupRecord, or IwbContainer to the specified file. The aAsNew boolean controls whether or not you're copying the record as an override record. | ||
|- align="left" style="background-color: #EEEEEE" | |- align="left" style="background-color: #EEEEEE" | ||
| scope="row" | <b> | | scope="row" | <b>wbCopyElementToRecord</b> || IwbElement || element : IwbElement , aMainRecord : IwbMainRecord , aAsNew : boolean , aDeepCopy : boolean || Copies an element to a record. E.g. the "conditions" element on a COBJ record, or a faction from an NPC_ record. | ||
|- align="left" style="background-color: #F8F8F8" | |- align="left" style="background-color: #F8F8F8" | ||
| 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 | ||
|} | |} | ||