Difference between revisions of "TES5Edit Scripting Functions"

Jump to navigation Jump to search
imported>ThreeTen
(Turns out GamePath was a const provided by an attached script., not a GV.)
imported>ThreeTen
Line 215: Line 215:
| 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(DataPath,'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(DataPath,'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]))
| scope="row" | <b>ObjectToElement</b> || IwbElement || slObject : 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])).  Trying to use this function on a TObject that is pointing to an override record will return nil.
|- align="left" style="background-color: #F8F8F8"
|- 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
Line 225: Line 225:
| scope="row" | <b>RecordByEditorID</b> || IwbMainRecord || file : IwbFile , editorid : string  ||  
| 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>RecordByFormID</b> || IwbMainRecord || file : IwbFile , formid : integer , aAllowInjected : boolean  || Will return the record with the specified FormID in the specified file, if it exists.
| 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.  Will ignore overrides.
|- align="left" style="background-color: #EEEEEE"
|- align="left" style="background-color: #EEEEEE"
| scope="row" | <b>RecordByIndex</b> || IwbMainRecord || file : IwbFile , index : integer  || Returns the reocrd at the specified index in the specified file.
| scope="row" | <b>RecordByIndex</b> || IwbMainRecord || file : IwbFile , index : integer  || Returns the reocrd at the specified index in the specified file.
Anonymous user

Navigation menu