View Single Post in: Sims 3 Script Extender Overview
#5
23rd Apr 2021 at 10:20 PM
23rd Apr 2021 at 10:20 PM
Posts: 436
Thanks: 976 in 6 Posts
Directory
Battery.S3SE.IO
Assembly LoadAssembly(string path)
Usage: Loads in the raw managed dll from the given path
Example:
Assembly LoadAssembly(string path, bool RunInitializer)
Usage: Loads in the raw managed dll from the given path, if you have a class called Main that has a static method called Initialize ( signature void Initialize() ) and the RunInitializer is set to true it will try to run that method right away.
Example:
Battery.S3SE.IO.Directory
string UserModDirectory
Usage: A property that returns the users mod directory as a string
Example:
bool Create(string path)
Usage: Creates a new Directory(folder) with the given path.
Note: the game needs permission to write to that location
Example:
bool DeleteDirectory(string path)
Usage: Deletes a Directory(folder) and its contents under the given path.
Note: the game needs permission to write to that location
Example:
bool Exists(string path)
Usage: Checks if the Directory(folder) exists under the given path and returns true if so
Example:
List<string> GetFiles(string path)
Usage: Returns all the files in a given directory path as a string list
Example:
List<string> GetFilesOfType(string path, string extension)
Usage: Returns all the files in a given directory path as a string list with the given extension (include the . like “.package” not just “package”)
Example:
List<string> GetFilesOfTypeContaining(string path, string extension, string MustContain)
Usage: Returns all the files in a given directory path as a string list with the given extension that also have to contain the string provided in “MustContain” (include the . like “.package” not just “package” for the extension)
Example:
List<string> GetFolders(string path)
Usage: Returns all the sub directories (folders) in a given directory path as a string list
Example:
string GetUserModFolderPath()
Usage:
Battery.S3SE.IO
Assembly LoadAssembly(string path)
Usage: Loads in the raw managed dll from the given path
Example:
Code:
string path = Sims3.UI.StringInputDialog.Show("Load Assembly File",@"Enter a path like A:/TestLib.dll","");
if(string.IsNullOrEmpty(path))
{
return true;
}
Assembly assembl = Battery.S3SE.IO.LoadAssembly(path);
if(assembl != null)
{
Battery.UI.MessageUtil.WriteNotification(assembl.FullName +"\nLoaded");
}
Assembly LoadAssembly(string path, bool RunInitializer)
Usage: Loads in the raw managed dll from the given path, if you have a class called Main that has a static method called Initialize ( signature void Initialize() ) and the RunInitializer is set to true it will try to run that method right away.
Example:
Code:
string path = Sims3.UI.StringInputDialog.Show("Load Assembly File",@"Enter a path like A:/TestLib.dll","");
if(string.IsNullOrEmpty(path))
{
return true;
}
bool InitOnLoad = Sims3.UI.AcceptCancelDialog.Show("Run Main->Initialize() for Assembly after load ?");
Assembly assembl = Battery.S3SE.IO.LoadAssembly(path, InitOnLoad);
if(assembl != null)
{
if(!InitOnLoad)
{
Battery.UI.MessageUtil.WriteNotification(assembl.FullName +"\nLoaded");
}
}
Battery.S3SE.IO.Directory
string UserModDirectory
Usage: A property that returns the users mod directory as a string
Example:
Code:
public override bool PrintUserPath()
{
Battery.UI.MessageUtil.WriteNotification(Battery.S3SE.IO.Directory.UserModDirectory);
return true;
}
bool Create(string path)
Usage: Creates a new Directory(folder) with the given path.
Note: the game needs permission to write to that location
Example:
Code:
Battery.S3SE.IO.Directory.Create( @"A:/NewFolder");
bool DeleteDirectory(string path)
Usage: Deletes a Directory(folder) and its contents under the given path.
Note: the game needs permission to write to that location
Example:
Code:
Battery.S3SE.IO.Directory.DeleteDirectory( @"A:/NewFolder");
bool Exists(string path)
Usage: Checks if the Directory(folder) exists under the given path and returns true if so
Example:
Code:
bool exists = Battery.S3SE.IO.Directory.Exists(@"A:/NewFolder");
List<string> GetFiles(string path)
Usage: Returns all the files in a given directory path as a string list
Example:
Code:
List<string> Files = Battery.S3SE.IO.Directory.GetFiles("C:/MyMusic");
List<string> GetFilesOfType(string path, string extension)
Usage: Returns all the files in a given directory path as a string list with the given extension (include the . like “.package” not just “package”)
Example:
Code:
List<string> files = Battery.S3SE.IO.Directory.GetFilesOfType("C:/Files/Content",".xml");
List<string> GetFilesOfTypeContaining(string path, string extension, string MustContain)
Usage: Returns all the files in a given directory path as a string list with the given extension that also have to contain the string provided in “MustContain” (include the . like “.package” not just “package” for the extension)
Example:
Code:
List<string> files = Battery.S3SE.IO.Directory.GetFilesOfTypeContaining("C:/", ".mp3", "Never Give");
List<string> GetFolders(string path)
Usage: Returns all the sub directories (folders) in a given directory path as a string list
Example:
Code:
List<string> folders = Battery.S3SE.IO.Directory.GetFolders("C:/Games");
string GetUserModFolderPath()
Usage:
Like the property “UserModDirectory” returns the users mod directory as a string. use the property instead for better performance !!!
Example:
Code:
Use "Battery.S3SE.IO.Directory.UserModDirectory" instead !