Difference between revisions of "TES5Edit Scripting Functions"

Jump to navigation Jump to search

TES5Edit Scripting Functions (edit)

Revision as of 13:16, 20 July 2013

5,174 bytes added ,  13:16, 20 July 2013
no edit summary
imported>Turulo
imported>Turulo
Line 1: Line 1:
Work in progress: To become the future home of scripting functions for TES5Edit. Turulo from the Nexus community started this but it's hard to do a lot of work alone.  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.


{| class="TES5Edit Scripting Functions" style="border-collapse: separate; border-spacing: 4; border: 1px solid #000; cellpadding: 5"
TES5Edit implements a script engine based on pascal syntax. The following table enumerates the functions exported by TES5Edit to the script engine that allows interacting with the editor's elements to perform various tasks such as finding records, fixing record conflicts, etc.  
|-
! scope="col" align="left" | Function
! scope="col" align="left" | Returns
! scope="col" align="left" | Arguments
! scope="col" align="left" | Description
|-
! scope="row" align="left" | Add
| IwbElement
| container : IwbContainer, name : string, silent = true : boolean,  
| Implemented for main records etc.


|-
The information in the table is not complete so please contribute by explaining these functions, their uses and by fixing mistakes in this information.
! scope="row" align="left" | AddElement
|
| container : IwbContainer , element : IwbElement , ,
|


|-
The types described by this table such as IwbElement, IwbFile, etc.. are internal and not directly accessible but instead the script engine receives a generic type named <b>IInterface</b> which is common to every object type returned by TES5Edit.
! scope="row" align="left" | AdditionalElementCount
The reason the internal types are shown in this table is because some functions expect references to specific types even if the object reference is being hold by the generic IInterface variable.
| integer
| container : IwbContainer, , ,  
|


|-
{| class="wikitable" style="background-color: #AAAAAA; cellpadding: 0"
! scope="row" align="left" | AddMasterIfMissing
|+TES5Edit Scripting Functions
|
|- align="left"
| file : IwbFile , mastername : string , ,
! scope="col" style="background-color: #DDDDDD" | Function
|  
! scope="col" style="background-color: #DDDDDD" | Returns
 
! scope="col" style="background-color: #DDDDDD" | Arguments
|-
! scope="col" style="background-color: #DDDDDD" | Description
! scope="row" align="left" | AddMessage
|- align="left" style="background-color: #F8F8F8"
|
| scope="row" | <b>Add</b> || IwbElement || container : IwbContainer, name : string, silent = true : boolean || Implemented for main records etc.
| message : string , , ,
|- align="left" style="background-color: #EEEEEE"
| Adds a message line into the TES5Edit output panel
| scope="row" | <b>AddElement</b> ||  || container : IwbContainer , element : IwbElement ||  
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>AdditionalElementCount</b> || integer || container : IwbContainer ||  
! scope="row" align="left" | AddNewFile
|- align="left" style="background-color: #EEEEEE"
| IwbFile
| scope="row" | <b>AddMasterIfMissing</b> ||  || file : IwbFile , mastername : string  ||  
| , , ,
|- align="left" style="background-color: #F8F8F8"
| Adds a new file and returns its reference
| scope="row" | <b>AddMessage</b> ||  || message : string  || Adds a message line into the TES5Edit output panel
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>AddNewFile</b> || IwbFile ||  || Adds a new file and returns its reference
! scope="row" align="left" | AddRequiredElementMasters
|- align="left" style="background-color: #F8F8F8"
| IwbFile
| scope="row" | <b>AddRequiredElementMasters</b> || IwbFile || aSourceElement : IwbElement , aTargetFile : IwbFile , aAsNew : boolean  || Add the element''s master into the target file.
| aSourceElement : IwbElement , aTargetFile : IwbFile , aAsNew : boolean ,
|- align="left" style="background-color: #EEEEEE"
| Add the element''s master into the target file.
| scope="row" | <b>Assigned</b> ||  || element : IwbElement  ||  
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>CanContainFormIDs</b> || boolean || element : IwbElement  ||
! scope="row" align="left" | Assigned
|- align="left" style="background-color: #EEEEEE"
|  
| scope="row" | <b>CanMoveDown</b> || boolean || element : IwbElement  ||
| element : IwbElement , , ,
|- align="left" style="background-color: #F8F8F8"
|  
| scope="row" | <b>CanMoveUp</b> || boolean || element : IwbElement ||  
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>ChangeFormSignature</b> ||  || record : IwbMainRecord , signature : TwbSignature  ||  
! scope="row" align="left" | CanContainFormIDs
|- align="left" style="background-color: #F8F8F8"
| boolean
| scope="row" | <b>Check</b> || boolean || element : IwbElement ||
| element : IwbElement , , ,
|- align="left" style="background-color: #EEEEEE"
|  
| scope="row" | <b>ChildGroup</b> || IwbGroupRecord || record : IwbMainRecord ||  
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>ChildrenOf</b> || IwbMainRecord || group : IwbGroupRecord  ||
! scope="row" align="left" | CanMoveDown
|- align="left" style="background-color: #EEEEEE"
| boolean
| scope="row" | <b>CleanMasters</b> ||  || file : IwbFile  ||  
| element : IwbElement , , ,
|- align="left" style="background-color: #F8F8F8"
|  
| scope="row" | <b>CompareExchangeFormID</b> || boolean || mainrecord : IwbMainRecord , oldFormID : Cardinal , aNewFormID : Cardinal  ||  
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>ConflictAllForMainRecord</b> || TConflictThis || record : IwbMainRecord  || Gets the ConflictThis argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums)
! scope="row" align="left" | CanMoveUp
|- align="left" style="background-color: #F8F8F8"
| boolean
| scope="row" | <b>ConflictAllForNode</b> || TConflictThis || node : IwbElement || Gets the ConflictAll argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums)
| element : IwbElement , , ,
|- align="left" style="background-color: #EEEEEE"
|
| 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"
|-
| scope="row" | <b>ConflictThisForNode</b> || TConflictThis || node : IwbElement  || Gets the ConflictAll argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums)
! scope="row" align="left" | ChangeFormSignature
|- align="left" style="background-color: #EEEEEE"
|  
| scope="row" | <b>ContainingMainRecord</b> || IwbMainRecord || element : IwbElement ||  
| record : IwbMainRecord , signature : TwbSignature , ,
|- align="left" style="background-color: #F8F8F8"
|  
| scope="row" | <b>DefType</b> || TwbDefType || element : IInterface  || returns the IwbElement::DefType (see dtXxxx enums)
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>ElementAssign</b> || IwbElement || container : IwbContainer , aInder : integer, [element : IwbElement], aOnlySK : boolean  || Adds a new element to the container
! scope="row" align="left" | Check
|- align="left" style="background-color: #F8F8F8"
| boolean
| scope="row" | <b>ElementByIndex</b> || IwbElement || container : IwbContainer , index : integer || Gets an element in the container by index
| element : IwbElement , , ,
|- align="left" style="background-color: #EEEEEE"
|  
| scope="row" | <b>ElementByName</b> || IwbElement || container : IwbContainer , name : string  || Gets an element in the container by name
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>ElementByPath</b> || IwbElement || container : IwbContainer , path : string  || Gets an element in the container by path
! scope="row" align="left" | ChildGroup
|- align="left" style="background-color: #EEEEEE"
| IwbGroupRecord
| scope="row" | <b>ElementBySignature</b> || IwbElement || container : IwbContainer , signature : string  || Gets an element in the container by its signature
| record : IwbMainRecord , , ,
|- align="left" style="background-color: #F8F8F8"
|
| scope="row" | <b>ElementCount</b> || integer || container : IwbContainer  || Returns the number of elements in a container
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>ElementExists</b> || boolean || container : IwbContainer , name : string || Checks if the name of the element already exist in the container
! scope="row" align="left" | ChildrenOf
|- align="left" style="background-color: #F8F8F8"
| IwbMainRecord
| scope="row" | <b>ElementType</b> || TwbElementType || element : IwbElement || Returns the ElementType of the element
| group : IwbGroupRecord , , ,
|- align="left" style="background-color: #EEEEEE"
|  
| scope="row" | <b>Equals</b> || boolean || element1 : IwbElement , element2 : IwbElement  || Compares both elements by their ElementID
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>FileByIndex</b> || IwbFile || index : integer  || Gets the file at the specified index
! scope="row" align="left" | CleanMasters
|- align="left" style="background-color: #EEEEEE"
|  
| scope="row" | <b>FileByLoadOrder</b> || IwbFile || loadorder : integer  || Gets the file at the specified load order
| file : IwbFile , , ,
|- align="left" style="background-color: #F8F8F8"
|  
| scope="row" | <b>FileFormIDtoLoadOrderFormID</b> || cardinal || file : IwbFile , formid : string/cardinal  ||  
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>FindChildGroup</b> || IwbGroupRecord || group : IwbGroupRecord , aType : integer , aMainRecord : IwbMainRecord  ||  
! scope="row" align="left" | CompareExchangeFormID
|- align="left" style="background-color: #F8F8F8"
| boolean
| scope="row" | <b>FixedFormID</b> || cardinal || aMainRecord : IwbMainRecord ||  
| mainrecord : IwbMainRecord , oldFormID : Cardinal , aNewFormID : Cardinal ,
|- align="left" style="background-color: #EEEEEE"
|
| scope="row" | <b>FormID</b> || cardinal || aMainRecord : IwbMainRecord || Obtains the FormID of the record
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>FullPath</b> || string || element : IwbElement  ||  
! scope="row" align="left" | ConflictAllForMainRecord
|- align="left" style="background-color: #EEEEEE"
| TConflictThis
| scope="row" | <b>GetContainer</b> || IwbContainer || element : IwbElement  || Gets the container of the element
| record : IwbMainRecord , , ,
|- align="left" style="background-color: #F8F8F8"
| Gets the ConflictThis argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums)
| scope="row" | <b>GetEditValue</b> || string || element : IwbElement || Gets the element's value represented as text
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>GetElementEditValues</b> || string || element : IwbElement , name : string || Gets the element's value represented as text
! scope="row" align="left" | ConflictAllForNode
|- align="left" style="background-color: #F8F8F8"
| TConflictThis
| scope="row" | <b>GetElementNativeValues</b> || variant || element : IwbElement , name : string  || Gets the element's native value
| node : IwbElement , , ,
|- align="left" style="background-color: #EEEEEE"
| Gets the ConflictAll argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums)
| scope="row" | <b>GetFile</b> || IwbFile || element : IwbElement  || Gets the file that defines the element
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>GetFileName</b> || string || file : IwbFile || Obtains the filename of the plugin file
! scope="row" align="left" | ConflictThisForMainRecord
|- align="left" style="background-color: #EEEEEE"
| TConflictThis
| scope="row" | <b>GetFormVersion</b> || cardinal || mainrecord : IwbMainRecord  ||  
| record : IwbMainRecord , , ,
|- align="left" style="background-color: #F8F8F8"
| Gets the ConflictThis argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums)
| scope="row" | <b>GetIsDeleted</b> || boolean || mainrecord : IwbMainRecord  || Indicates if the record has been deleted
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>GetIsESM</b> || boolean || file : IwbFile  || Indicates if the plugin is an ESM file
! scope="row" align="left" | ConflictThisForNode
|- align="left" style="background-color: #F8F8F8"
| TConflictThis
| scope="row" | <b>GetIsInitiallyDisabled</b> || boolean || mainrecord : IwbMainRecord ||  
| node : IwbElement , , ,
|- align="left" style="background-color: #EEEEEE"
| Gets the ConflictAll argument of the record by calling ConflictLevelForMainRecord (see ctXxxxx enums)
| scope="row" | <b>GetIsPersistent</b> || boolean || mainrecord : IwbMainRecord ||  
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>GetIsVisibleWhenDistant</b> || boolean || mainrecord : IwbMainRecord ||  
! scope="row" align="left" | ContainingMainRecord
|- align="left" style="background-color: #EEEEEE"
| IwbMainRecord
| scope="row" | <b>GetLoadOrder</b> || cardinal || file : IwbFile  || Gets the global load order of the file
| element : IwbElement , , ,
|- align="left" style="background-color: #F8F8F8"
|  
| scope="row" | <b>GetLoadOrderFormID</b> || cardinal || mainrecord : IwbMainRecord  || Obtains the FormID with the current load order applied
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>GetNativeValue</b> || variant || element : IwbElement  || Gets the element's native value
! scope="row" align="left" | DefType
|- align="left" style="background-color: #F8F8F8"
| TwbDefType
| scope="row" | <b>GroupBySignature</b> ||  || file : IwbFile , signature : string  ||  
| element : IInterface , , ,
|- align="left" style="background-color: #EEEEEE"
| returns the IwbElement::DefType (see dtXxxx enums)
| scope="row" | <b>GroupLabel</b> || cardinal || group : IwbGroupRecord  ||  
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>GroupType</b> || integer || group : IwbGroupRecord  ||  
! scope="row" align="left" | ElementAssign
|- align="left" style="background-color: #EEEEEE"
| IwbElement
| scope="row" | <b>HasGroup</b> || boolean || file : IwbFile , signature : string  ||  
| container : IwbContainer , aInder : integer, [element : IwbElement], aOnlySK : boolean
|- align="left" style="background-color: #F8F8F8"
| Adds a new element to the container
| 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: #EEEEEE"
|-
| scope="row" | <b>IndexOf</b> || integer || container : IwbContainer , element : IwbElement  || Gets the index of the element inside the collection
! scope="row" align="left" | ElementByIndex
|- align="left" style="background-color: #F8F8F8"
| IwbElement
| scope="row" | <b>InsertElement</b> ||  || container : IwbContainer , position : integer , element : IwbElement  || Inserts an existing element inside a collection by position
| container : IwbContainer , index : integer , ,
|- align="left" style="background-color: #EEEEEE"
| Gets an element in the container by index
| scope="row" | <b>IsEditable</b> || boolean || element : IwbElement  ||  
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>IsInjected</b> || boolean || element : IwbElement  ||  
! scope="row" align="left" | ElementByName
|- align="left" style="background-color: #EEEEEE"
| IwbElement
| scope="row" | <b>IsMaster</b> || boolean || record : IwbMainRecord  ||  
| container : IwbContainer , name : string , ,
|- align="left" style="background-color: #F8F8F8"
| Gets an element in the container by name
| scope="row" | <b>IsWinningOverride</b> || boolean || record : IwbMainRecord ||  
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>JumpTo</b> || TConflictThis || record : IwbMainRecord , backward : boolean  || Selects the specified record
! scope="row" align="left" | ElementByPath
|- align="left" style="background-color: #F8F8F8"
| IwbElement
| scope="row" | <b>LastElement</b> || IwbElement || container : IwbContainer  || Obtains the last element in the collection
| container : IwbContainer , path : string , ,
|- align="left" style="background-color: #EEEEEE"
| Gets an element in the container by path
| scope="row" | <b>LinksTo</b> || IwbElement || element : IwbElement  || Obtains the referenced element
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>LoadOrderFormIDtoFileFormID</b> || cardinal || file : IwbFile , aFormID : cardinal  ||  
! scope="row" align="left" | ElementBySignature
|- align="left" style="background-color: #EEEEEE"
| IwbElement
| scope="row" | <b>MainRecordByEditorID</b> || IwbMainRecord || group : IwbGroupRecord  || Does not work for every case because its inefficient
| container : IwbContainer , signature : string , ,
|- align="left" style="background-color: #F8F8F8"
| Gets an element in the container by its signature
| scope="row" | <b>Master</b> || IInterface || record : IwbMainRecord  ||  
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>MasterByIndex</b> || IInterface || file : IwbFile , index : integer  ||  
! scope="row" align="left" | ElementCount
|- align="left" style="background-color: #F8F8F8"
| integer
| scope="row" | <b>MasterCount</b> || cardinal || file : IwbFile  ||  
| container : IwbContainer , , ,
|- align="left" style="background-color: #EEEEEE"
| Returns the number of elements in a container
| scope="row" | <b>MasterOrSelf</b> || IwbMainRecord || record : IwbMainRecord  ||  
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>MoveDown</b> ||  || element : IwbElement  || Moves the element down
! scope="row" align="left" | ElementExists
|- align="left" style="background-color: #EEEEEE"
| boolean
| scope="row" | <b>MoveUp</b> ||  || element : IwbElement || Moves the element up
| container : IwbContainer , name : string , ,
|- align="left" style="background-color: #F8F8F8"
| Checks if the name of the element already exist in the container
| scope="row" | <b>Name</b> ||  || element : IwbElement  || Obtains the name of the element
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>OverrideByIndex</b> || IwbMainRecord || record : IwbMainRecord , index : integer  ||
! scope="row" align="left" | ElementType
|- align="left" style="background-color: #F8F8F8"
| TwbElementType
| scope="row" | <b>OverrideCount</b> || cardinal || record : IwbMainRecord ||  
| element : IwbElement , , ,
|- align="left" style="background-color: #EEEEEE"
| Returns the ElementType of the element
| scope="row" | <b>Path</b> || string || element : IwbElement  ||  
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>RecordByEditorID</b> || IwbMainRecord || file : IwbFile , editorid : string  ||  
! scope="row" align="left" | Equals
|- align="left" style="background-color: #EEEEEE"
| boolean
| scope="row" | <b>RecordByFormID</b> || IwbMainRecord || file : IwbFile , formid : integer , aAllowInjected : boolean ||  
| element1 : IwbElement , element2 : IwbElement , ,
|- align="left" style="background-color: #F8F8F8"
| Compares both elements by their ElementID
| scope="row" | <b>RecordByIndex</b> || IwbMainRecord || file : IwbFile , index : integer  ||  
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>RecordCount</b> || cardinal || file : IwbFile  ||  
! scope="row" align="left" | FileByIndex
|- align="left" style="background-color: #F8F8F8"
| IwbFile
| scope="row" | <b>ReferencedByCount</b> || cardinal || record : IwbMainRecord ||  
| index : integer , , ,
|- align="left" style="background-color: #EEEEEE"
| Gets the file at the specified index
| scope="row" | <b>ReferencedByIndex</b> || IwbMainRecord || record : IwbMainRecord , index : integer  ||  
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>Remove</b> ||  || element : IwbElement ||  
! scope="row" align="left" | FileByLoadOrder
|- align="left" style="background-color: #EEEEEE"
| IwbFile
| scope="row" | <b>RemoveByIndex</b> || IwbElement || container : IwbContainer , index : integer , aMarkModified : boolean  ||  
| loadorder : integer , , ,
|- align="left" style="background-color: #F8F8F8"
| Gets the file at the specified load order
| scope="row" | <b>RemoveElement</b> || IwbElement || container : IwbContainer , element : IwbElement  ||  
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>RemoveNode</b> || boolean || node : IwbElement  || Removes the node from the file
! scope="row" align="left" | FileFormIDtoLoadOrderFormID
|- align="left" style="background-color: #F8F8F8"
| cardinal
| scope="row" | <b>ResourceCopy</b> ||  || container : IwbContainer , fileName : string , pathOut : string , containerIndex : integer  ||  
| file : IwbFile , formid : string/cardinal , ,
|- align="left" style="background-color: #EEEEEE"
|
| scope="row" | <b>ResourceCount</b> || cardinal || container : IwbContainer , aFileName : string , containers : TStrings  ||  
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>ResourceExists</b> || boolean || container : IwbContainer , aFileName : string  ||
! scope="row" align="left" | FindChildGroup
|- align="left" style="background-color: #EEEEEE"
| IwbGroupRecord
| scope="row" | <b>ResourceList</b> ||  || container : IwbContainer , aContainerName : string , containers : TStrings  ||
| group : IwbGroupRecord , aType : integer , aMainRecord : IwbMainRecord ,
|- align="left" style="background-color: #F8F8F8"
|  
| scope="row" | <b>ReverseElements</b> ||  || container : IwbContainer  ||
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>SetEditValue</b> ||  || element : IwbElement , value : string  || Sets the value of the element as string
! scope="row" align="left" | FixedFormID
|- align="left" style="background-color: #F8F8F8"
| cardinal
| scope="row" | <b>SetElementEditValues</b> ||  || container : IwbContainer , path : string , value : string  || Sets the value as a string of the element by its path
| aMainRecord : IwbMainRecord , , ,
|- align="left" style="background-color: #EEEEEE"
|  
| 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"
|-
| scope="row" | <b>SetFormVersion</b> ||  || record : IwbMainRecord , version : integer  ||
! scope="row" align="left" | FormID
|- align="left" style="background-color: #EEEEEE"
| cardinal
| scope="row" | <b>SetIsDeleted</b> ||  || record : IwbMainRecord , value : boolean  ||
| aMainRecord : IwbMainRecord , , ,
|- align="left" style="background-color: #F8F8F8"
| Obtains the FormID of the record
| scope="row" | <b>SetIsESM</b> ||  || file : IwbFile , value : boolean  ||
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>SetIsInitiallyDisabled</b> ||  || record : IwbMainRecord , value : boolean  ||
! scope="row" align="left" | FullPath
|- align="left" style="background-color: #F8F8F8"
| string
| scope="row" | <b>SetIsPersistent</b> ||  || record : IwbMainRecord , value : boolean  ||
| element : IwbElement , , ,
|- align="left" style="background-color: #EEEEEE"
|
| scope="row" | <b>SetIsVisibleWhenDistant</b> ||  || record : IwbMainRecord , value : boolean  ||
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>SetLoadOrderFormID</b> ||  || record : IwbMainRecord , loadOrderFormId : cardinal  ||
! scope="row" align="left" | GetContainer
|- align="left" style="background-color: #EEEEEE"
| IwbContainer
| scope="row" | <b>SetNativeValue</b> ||  || element : IwbElement , value : variant  || Sets the native value of the element
| element : IwbElement , , ,
|- align="left" style="background-color: #F8F8F8"
| Gets the container of the element
| scope="row" | <b>ShortName</b> || string || element : IwbElement  || Gets the short name of the element
 
|- align="left" style="background-color: #EEEEEE"
|-
| scope="row" | <b>Signature</b> || string || record : IwbMainRecord  ||
! scope="row" align="left" | GetEditValue
|- align="left" style="background-color: #F8F8F8"
| string
| scope="row" | <b>SortKey</b> || string || element : IwbElement, aExtended: boolean  ||
| element : IwbElement , , ,
|- align="left" style="background-color: #EEEEEE"
| Gets the element's value represented as text
| scope="row" | <b>SortMasters</b> ||  || file : IwbFile  ||
 
|- align="left" style="background-color: #F8F8F8"
|-
| scope="row" | <b>wbCopyElementToFile</b> || IwbElement || element : IwbElement , file : IwbFile , aAsNew : boolean , aDeepCopy : boolean  ||
! scope="row" align="left" | GetElementEditValues
|- align="left" style="background-color: #EEEEEE"
| string
| scope="row" | <b>wbCopyElementToRecord</b> || IwbElement || element : IwbElement , aMainRecord : IwbMainRecord , aAsNew : boolean , aDeepCopy : boolean  ||
| element : IwbElement , name : string , ,
|- align="left" style="background-color: #F8F8F8"
| Gets the element's value represented as text
| scope="row" | <b>WinningOverride</b> || boolean || record : IwbMainRecord  ||
 
|-
! scope="row" align="left" | GetElementNativeValues
| variant
| element : IwbElement , name : string , ,
| Gets the element's native value
 
|-
! scope="row" align="left" | GetFile
| IwbFile
| element : IwbElement , , ,
| Gets the file that defines the element
 
|-
! scope="row" align="left" | GetFileName
| string
| file : IwbFile , , ,
| Obtains the filename of the plugin file
 
|-
! scope="row" align="left" | GetFormVersion
| cardinal
| mainrecord : IwbMainRecord , , ,
|
 
|-
! scope="row" align="left" | GetIsDeleted
| boolean
| mainrecord : IwbMainRecord , , ,
| Indicates if the record has been deleted
 
|-
! scope="row" align="left" | GetIsESM
| boolean
| file : IwbFile , , ,
| Indicates if the plugin is an ESM file
 
|-
! scope="row" align="left" | GetIsInitiallyDisabled
| boolean
| mainrecord : IwbMainRecord , , ,
|  
 
|-
! scope="row" align="left" | GetIsPersistent
| boolean
| mainrecord : IwbMainRecord , , ,
|  
 
|-
! scope="row" align="left" | GetIsVisibleWhenDistant
| boolean
| mainrecord : IwbMainRecord , , ,
|  
 
|-
! scope="row" align="left" | GetLoadOrder
| cardinal
| file : IwbFile , , ,
| Gets the global load order of the file
 
|-
! scope="row" align="left" | GetLoadOrderFormID
| cardinal
| mainrecord : IwbMainRecord , , ,
| Obtains the FormID with the current load order applied
 
|-
! scope="row" align="left" | GetNativeValue
| variant
| element : IwbElement , , ,
| Gets the element's native value
 
|-
! scope="row" align="left" | GroupBySignature
|  
| file : IwbFile , signature : string , ,
|  
 
|-
! scope="row" align="left" | GroupLabel
| cardinal
| group : IwbGroupRecord , , ,
|  
 
|-
! scope="row" align="left" | GroupType
| integer
| group : IwbGroupRecord , , ,
|  
 
|-
! scope="row" align="left" | HasGroup
| boolean
| file : IwbFile , signature : string , ,
|  
 
|-
! scope="row" align="left" | HasMaster
| boolean
| file : IwbFile , signature : string , ,
| Returns true if the file has a master file defined
 
|-
! scope="row" align="left" | IndexOf
| integer
| container : IwbContainer , element : IwbElement , ,
| Gets the index of the element inside the collection
 
|-
! scope="row" align="left" | InsertElement
|  
| container : IwbContainer , position : integer , element : IwbElement ,
| Inserts an existing element inside a collection by position
 
|-
! scope="row" align="left" | IsEditable
| boolean
| element : IwbElement , , ,
|  
 
|-
! scope="row" align="left" | IsInjected
| boolean
| element : IwbElement , , ,
|  
 
|-
! scope="row" align="left" | IsMaster
| boolean
| record : IwbMainRecord , , ,
|  
 
|-
! scope="row" align="left" | IsWinningOverride
| boolean
| record : IwbMainRecord , , ,
|  
 
|-
! scope="row" align="left" | JumpTo
| TConflictThis
| record : IwbMainRecord , backward : boolean , ,
| Selects the specified record
 
|-
! scope="row" align="left" | LastElement
| IwbElement
| container : IwbContainer , , ,
| Obtains the last element in the collection
 
|-
! scope="row" align="left" | LinksTo
| IwbElement
| element : IwbElement , , ,
| Obtains the referenced element
 
|-
! scope="row" align="left" | LoadOrderFormIDtoFileFormID
| cardinal
| file : IwbFile , aFormID : cardinal , ,
|  
 
|-
! scope="row" align="left" | MainRecordByEditorID
| IwbMainRecord
| group : IwbGroupRecord , , ,
| Does not work for every case because its inefficient
 
|-
! scope="row" align="left" | Master
| IInterface
| record : IwbMainRecord , , ,
|  
 
|-
! scope="row" align="left" | MasterByIndex
| IInterface
| file : IwbFile , index : integer , ,
|  
 
|-
! scope="row" align="left" | MasterCount
| cardinal
| file : IwbFile , , ,
|
 
|-
! scope="row" align="left" | MasterOrSelf
| IwbMainRecord
| record : IwbMainRecord , , ,
|  
 
|-
! scope="row" align="left" | MoveDown
|  
| element : IwbElement , , ,
| Moves the element down
 
|-
! scope="row" align="left" | MoveUp
|  
| element : IwbElement , , ,
| Moves the element up
 
|-
! scope="row" align="left" | Name
|  
| element : IwbElement , , ,
| Obtains the name of the element
 
|-
! scope="row" align="left" | OverrideByIndex
| IwbMainRecord
| record : IwbMainRecord , index : integer , ,
|  
 
|-
! scope="row" align="left" | OverrideCount
| cardinal
| record : IwbMainRecord , , ,
|
 
|-
! scope="row" align="left" | Path
| string
| element : IwbElement , , ,
|  
 
|-
! scope="row" align="left" | RecordByEditorID
| IwbMainRecord
| file : IwbFile , editorid : string , ,
|  
 
|-
! scope="row" align="left" | RecordByFormID
| IwbMainRecord
| file : IwbFile , formid : integer , aAllowInjected : boolean ,
|  
 
|-
! scope="row" align="left" | RecordByIndex
| IwbMainRecord
| file : IwbFile , index : integer , ,
|  
 
|-
! scope="row" align="left" | RecordCount
| cardinal
| file : IwbFile , , ,
|
 
|-
! scope="row" align="left" | ReferencedByCount
| cardinal
| record : IwbMainRecord , , ,
|  
 
|-
! scope="row" align="left" | ReferencedByIndex
| IwbMainRecord
| record : IwbMainRecord , index : integer , ,
|  
 
|-
! scope="row" align="left" | Remove
|  
| element : IwbElement , , ,
|  
 
|-
! scope="row" align="left" | RemoveByIndex
| IwbElement
| container : IwbContainer , index : integer , aMarkModified : boolean ,
|  
 
|-
! scope="row" align="left" | RemoveElement
| IwbElement
| container : IwbContainer , element : IwbElement , ,
|  
 
|-
! scope="row" align="left" | RemoveNode
| boolean
| node : IwbElement , , ,
| Removes the node from the file
 
|-
! scope="row" align="left" | ResourceCopy
|  
| container : IwbContainer , fileName : string , pathOut : string , containerIndex : integer
|  
 
|-
! scope="row" align="left" | ResourceCount
| cardinal
| container : IwbContainer , aFileName : string , containers : TStrings ,
|  
 
|-
! scope="row" align="left" | ResourceExists
| boolean
| container : IwbContainer , aFileName : string , ,
|  
 
|-
! scope="row" align="left" | ResourceList
|  
| container : IwbContainer , aContainerName : string , containers : TStrings ,
|  
 
|-
! scope="row" align="left" | ReverseElements
|  
| container : IwbContainer , , ,
|  
 
|-
! scope="row" align="left" | SetEditValue
|  
| element : IwbElement , value : string , ,
| Sets the value of the element as string
 
|-
! scope="row" align="left" | SetElementEditValues
|  
| container : IwbContainer , path : string , value : string ,
| Sets the value as a string of the element by its path
 
|-
! scope="row" align="left" | SetElementNativeValues
|  
| container : IwbContainer , path : string , value : variant ,
| Sets the native value of the element by its path
 
|-
! scope="row" align="left" | SetFormVersion
|  
| record : IwbMainRecord , version : integer , ,
|  
 
|-
! scope="row" align="left" | SetIsDeleted
|  
| record : IwbMainRecord , value : boolean , ,
|  
 
|-
! scope="row" align="left" | SetIsESM
|  
| file : IwbFile , value : boolean , ,
|  
 
|-
! scope="row" align="left" | SetIsInitiallyDisabled
|  
| record : IwbMainRecord , value : boolean , ,
|  
 
|-
! scope="row" align="left" | SetIsPersistent
|  
| record : IwbMainRecord , value : boolean , ,
|  
 
|-
! scope="row" align="left" | SetIsVisibleWhenDistant
|  
| record : IwbMainRecord , value : boolean , ,
|  
 
|-
! scope="row" align="left" | SetLoadOrderFormID
|  
| record : IwbMainRecord , loadOrderFormId : cardinal , ,
|  
 
|-
! scope="row" align="left" | SetNativeValue
|  
| element : IwbElement , value : variant , ,
| Sets the native value of the element
 
|-
! scope="row" align="left" | ShortName
| string
| element : IwbElement , , ,
| Gets the short name of the element
 
|-
! scope="row" align="left" | Signature
| string
| record : IwbMainRecord , , ,
|  
 
|-
! scope="row" align="left" | SortKey
| string
| element : IwbElement, aExtended: boolean , ,
|  
 
|-
! scope="row" align="left" | SortMasters
|  
| file : IwbFile , , ,
|  
 
|-
! scope="row" align="left" | wbCopyElementToFile
| IwbElement
| element : IwbElement , file : IwbFile , aAsNew : boolean , aDeepCopy : boolean
|  
 
|-
! scope="row" align="left" | wbCopyElementToRecord
| IwbElement
| element : IwbElement , aMainRecord : IwbMainRecord , aAsNew : boolean , aDeepCopy : boolean
|  
 
|-
! scope="row" align="left" | WinningOverride
| boolean
| record : IwbMainRecord , , ,  
|}
|}
Anonymous user
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/16436"

Navigation menu