Function list (other languages)
[Previous] [Main] [Next]

This is simply a copy of the interface that scripts have access to. See the obmm script functions list for definitions of what most of the functions do.

When using python you don't need to access this interface directly; functions are defined which access the interface for you. If you want to use the interface, it is stored in a global variable named 'obmm'. (i.e. 'obmm.Message("bingle")' is equivelent to 'Message("bingle")' )

public interface IScriptFunctions {
bool
GetDisplayWarnings();

bool
DialogYesNo(string msg);
bool
DialogYesNo(string msg, string title);
bool
DataFileExists(string path);
Version
GetOBMMVersion();
Version
GetOBSEVersion();
Version
GetOBGEVersion();
Version
GetOblivionVersion();
Version
GetOBSEPluginVersion(string plugin);

string
[] GetPlugins(string path, string pattern, bool recurse);
string
[] GetDataFiles(string path, string pattern, bool recurse);
string
[] GetPluginFolders(string path, string pattern, bool recurse);
string
[] GetDataFolders(string path, string pattern, bool recurse);

string
[] GetExistingEspNames();
string
[] GetActiveOmodNames();

string
[] Select(string[] items, string[] previews, string[] descs, string title, bool many);

void
Message(string msg);
void
Message(string msg, string title);
void
DisplayImage(string path);
void
DisplayImage(string path, string title);
void
DisplayText(string path);
void
DisplayText(string path, string title);

void
LoadBefore(string plugin1, string plugin2);
void
LoadAfter(string plugin1, string plugin2);
void
SetNewLoadOrder(string[] plugins);

void
UncheckEsp(string plugin);
void
SetDeactivationWarning(string plugin, DeactiveStatus warning);

void
ConflictsWith(string filename);
void
ConslictsWith(string filename, string comment);
void
ConflictsWith(string filename, string comment, ConflictLevel level);
void
ConflictsWith(string name, int minMajorVersion, int minMinorVersion, int maxMajorVersion, int maxMinorVersion);
void
ConflictsWith(string name, int minMajorVersion, int minMinorVersion, int maxMajorVersion, int maxMinorVersion, string comment);
void
ConflictsWith(string name, int minMajorVersion, int minMinorVersion, int maxMajorVersion, int maxMinorVersion, string comment, ConflictLevel level);
void
ConflictsWith(string name, int minMajorVersion, int minMinorVersion, int maxMajorVersion, int maxMinorVersion, string comment, ConflictLevel level, bool regex);
void
DependsOn(string filename);
void
DependsOn(string filename, string comment);
void
DependsOn(string name, int minMajorVersion, int minMinorVersion, int maxMajorVersion, int maxMinorVersion);
void
DependsOn(string name, int minMajorVersion, int minMinorVersion, int maxMajorVersion, int maxMinorVersion, string comment);
void
DependsOn(string name, int minMajorVersion, int minMinorVersion, int maxMajorVersion, int maxMinorVersion, string comment, bool regex);

void
DontInstallAnyPlugins();
void
DontInstallAnyDataFiles();
void
InstallAllPlugins();
void
InstallAllDataFiles();

void
DontInstallPlugin(string name);
void
DontInstallDataFile(string name);
void
DontInstallDataFolder(string folder, bool recurse);
void
InstallPlugin(string name);
void
InstallDataFile(string name);
void
InstallDataFolder(string folder, bool recurse);

void
CopyPlugin(string from, string to);
void
CopyDataFile(string from, string to);
void
CopyDataFolder(string from, string to, bool recurse);

void
PatchPlugin(string from, string to, bool create);
void
PatchDataFile(string from, string to, bool create);

void
RegisterBSA(string path);
void
UnregisterBSA(string path);

void
EditINI(string section, string key, string value);
void
EditShader(byte package, string name, string path);

void
FatalError();

void
SetGMST(string file, string edid, string value);
void
SetGlobal(string file, string edid, string value);

void
SetPluginByte(string file, long offset, byte value);
void
SetPluginShort(string file, long offset, short value);
void
SetPluginInt(string file, long offset, int value);
void
SetPluginLong(string file, long offset, long value);
void
SetPluginFloat(string file, long offset, float value);

string
InputString();
string
InputString(string title);
string
InputString(string title, string initial);

string
ReadINI(string section, string value);
string
ReadRendererInfo(string value);

void
EditXMLLine(string file, int line, string value);
void
EditXMLReplace(string file, string find, string replace);

System.Windows.Forms.Form
CreateCustomDialog();

byte
[] ReadDataFile(string file);
byte
[] ReadExistingDataFile(string file);
byte
[] GetDataFileFromBSA(string file);
byte
[] GetDataFileFromBSA(string bsa, string file);

void
GenerateNewDataFile(string file, byte[] data);
void
GenerateBSA(string file, string path, string prefix, int cRatio, int cLevel);

bool
IsSimulation();
}