BrawlCrate.API.BrawlAPI Class Reference

Static Public Member Functions
static List< T >	NodeListOfType< T > ()
	Returns a full list of all nodes of a given type in the open file. More...
static List< T >	NodeWrapperListOfType< T > ()
	Returns a full list of all node wrappers of a given type in the open file. More...
static void	ShowMessage (string msg, string title)
	Shows a MessageBox with the given message and title, and the default "OK" option. More...
static void	ShowWarning (string msg, string title)
	Shows a MessageBox with the given message and title, the default "OK" option, and a Warning symbol. More...
static void	ShowError (string msg, string title)
	Shows a MessageBox with the given message and title, the default "OK" option, and an Error symbol. More...
static bool	ShowYesNoPrompt (string msg, string title)
	Shows a MessageBox with the given message and title, with options for "Yes" or "No". More...
static bool	ShowYesNoWarning (string msg, string title)
	Shows a MessageBox with the given message and title, "Yes/No" options, and a Warning symbol. More...
static bool	ShowYesNoError (string msg, string title)
	Shows a MessageBox with the given message and title, "Yes/No" options, and an Error symbol. More...
static bool	ShowOKCancelPrompt (string msg, string title)
	Shows a MessageBox with the given message and title, with options for "OK" or "Cancel". More...
static bool	ShowOKCancelWarning (string msg, string title)
	Shows a MessageBox with the given message and title, "OK/Cancel" options, and a Warning symbol. More...
static bool	ShowOKCancelError (string msg, string title)
	Shows a MessageBox with the given message and title, "OK/Cancel" options, and an Error symbol. More...
static string	OpenFileDialog ()
	Opens an open file dialog, prompting the user to select a file. More...
static string	OpenFileDialog (string title)
	Opens an open file dialog, prompting the user to select a file. More...
static string	OpenFileDialog (string title, string filter)
	Opens an open file dialog, prompting the user to select a file. More...
static string[]	OpenMultiFileDialog ()
	Opens an open file dialog, prompting the user to select multiple files More...
static string[]	OpenMultiFileDialog (string title)
	Opens an open file dialog, prompting the user to select multiple files More...
static string[]	OpenMultiFileDialog (string title, string filter)
	Opens an open file dialog, prompting the user to select multiple files More...
static string	OpenFolderDialog ()
	Opens an Open Folder Dialog, prompting the user to select a folder. More...
static string	OpenFolderDialog (string description)
	Opens an Open Folder Dialog, prompting the user to select a folder. More...
static string	SaveFileDialog ()
	Opens a save file dialog, prompting the user to save a file. More...
static string	SaveFileDialog (string title)
	Opens a save file dialog, prompting the user to save a file. More...
static string	SaveFileDialog (string title, string filter)
	Opens a save file dialog, prompting the user to save a file. More...
static string	UserStringInput ()
	Prompts the user to input a string, with a default title and the last BrawlAPI-entered string as the default value. More...
static string	UserStringInput (string title)
	Prompts the user to input a string, with the last BrawlAPI-entered string as the default value. More...
static string	UserStringInput (string title, string defaultText)
	Prompts the user to input a string with a default starting value. More...
static int	UserIntegerInput ()
	Prompts the user to input an integer. More...
static int	UserIntegerInput (string title)
	Prompts the user to input an integer. More...
static int	UserIntegerInput (string title, string description)
	Prompts the user to input an integer. More...
static int	UserIntegerInput (string title, string description, int defaultValue)
	Prompts the user to input an integer. More...
static int	UserIntegerInput (string title, string description, int defaultValue, int minimumValue)
	Prompts the user to input an integer. More...
static int	UserIntegerInput (string title, string description, int defaultValue, int minimumValue, int maximumValue)
	Prompts the user to input an integer. More...
static float	UserFloatInput (string title)
	Prompts the user to input a float. More...
static float	UserFloatInput (string title, string description)
	Prompts the user to input a float. More...
static float	UserFloatInput (string title, string description, float defaultValue)
	Prompts the user to input a float. More...
static float	UserFloatInput (string title, string description, float defaultValue, float minimumValue)
	Prompts the user to input a float. More...
static float	UserFloatInput (string title, string description, float defaultValue, float minimumValue, float maximumValue)
	Prompts the user to input a float. More...
static void	AddContextMenuItem (Type wrapper, params ToolStripMenuItem[] items)
	To be called by API, adds context menu items to a wrapper. More...
static void	AddContextMenuItem (Type wrapper, string subMenuName, string description, EventHandler conditional, params ToolStripMenuItem[] items)
	To be called by API, adds context menu items to a wrapper with additional options. More...
static void	AddMultiSelectContextMenuItem (Type wrapper, params ToolStripMenuItem[] items)
	To be called by API, adds context menu items to a wrapper's multi-selection menu. More...
static void	AddMultiSelectContextMenuItem (Type wrapper, string subMenuName, string description, EventHandler conditional, params ToolStripMenuItem[] items)
	To be called by API, adds context menu items to a wrapper's multi-selection menu with additional options. More...
static bool	New< T > ()
	Creates a new ResourceNode of type T and attempts to set it as the root node. More...
static bool	OpenFile (string path)
	Attempts to open the file using a given path. More...
static bool	OpenFileNoErrors (string path)
	Attempts to open the file using a given path. Any error messages (including "file not found") are not shown to the user. More...
static bool	OpenTemplate (string path)
	Attempts to open the file as a template using a given path. More...
static bool	OpenTemplateNoErrors (string path)
	Attempts to open the file using a given path. Any error messages (including "file not found") are not shown to the user. More...
static bool	SaveFile ()
	Attempts to save the opened file. More...
static bool	SaveFileAs ()
	Prompts the user to save the open file to a directory. More...
static bool	SaveFileAs (string path)
	Attempts to save the opened file to a given path. More...
static bool	CloseFile ()
	Closes the open file, leaving the editor on the idle screen. More...
static bool	ForceCloseFile ()
	Closes the open file, leaving the editor on the idle screen. More...
static void	RefreshPreview ()
	Refreshes the preview on the main window. More...
static void	Wait (int milliseconds)
	Causes the current thread to sleep for a number of milliseconds. More...
static void	AddResourceParser (PluginResourceParser resourceParser)
	Adds parsing for a specific user-defined file type. More...
static void	AddWrapper (ResourceType resourceType, PluginWrapper wrapper)
	Adds a wrapper for a specific user-defined file type. More...
static void	AddWrapper< TypeNode > (PluginWrapper wrapper)
	Adds a wrapper for a specific user-defined node type. More...
static void	WriteToConsole (string msg)
	Writes a message to the the console and debug log (if debugging) and the Trace log (if enabled). More...

Properties
static ResourceNode	RootNode [get]
	The root node of the opened file. More...
static ResourceNode	SelectedNode [get]
	The currently selected node on the Main Form. Useful for context menu items. More...
static List< ResourceNode >	SelectedNodes [get]
	The currently selected nodes on the Main Form. More...
static List< ResourceNode >	NodeList [get]
	Returns a full list of all nodes in the open file. More...
static BaseWrapper	RootNodeWrapper [get]
	The wrapper for the root node of the opened file. More...
static BaseWrapper	SelectedNodeWrapper [get]
	The wrapper for the currently selected node on the Main Form. Useful for context menu items. More...
static List< BaseWrapper >	SelectedNodeWrappers [get]
	The wrappers for the currently selected nodes on the Main Form. More...
static List< BaseWrapper >	NodeWrapperList [get]
	Returns a full list of all node wrappers in the open file. More...
static string	AppPath [get]
	The folder in which the BrawlCrate installation is located. More...
static string	APIPath [get]
	The folder in which the API folders are located. More...
static string	LibPath [get]
	The folder in which API libraries are located. More...
static string	PluginPath [get]
	The folder in which plugins are located. More...
static string	LoaderPath [get]
	The folder in which loaders are located. More...
static string	ResourcesPath [get]
	The folder in which API resources are located. More...

Member Function Documentation

AddContextMenuItem() [1/2]

static void BrawlCrate.API.BrawlAPI.AddContextMenuItem ( Type  wrapper, params ToolStripMenuItem[]  items  )

inlinestatic

To be called by API, adds context menu items to a wrapper.

This is kept for compatibility purposes, the second definition for this function offers far more extensibility.

Parameters

wrapper	The wrapper which new items will be added to.
items	One or more ToolStrip menu items that will be added to the context menu. These should be defined as much as possible in the script itself.

        {
            if (BrawlAPIInternal.ContextMenuHooks.ContainsKey(wrapper))
            {
                if (items.Length == 1 && items[0].HasDropDownItems)
                {
                    // Combine same-named submenus
                    for (int i = 0; i < BrawlAPIInternal.ContextMenuHooks[wrapper].Length; i++)
                    {
                        ToolStripMenuItem item = BrawlAPIInternal.ContextMenuHooks[wrapper][i];
                        if (!item.HasDropDownItems || item.Text != items[0].Text)
                        {
                            continue;
                        }
 
                        if (string.IsNullOrEmpty(item.ToolTipText))
                        {
                            item.ToolTipText = items[0].ToolTipText;
                        }
 
                        for (int j = 0; j < items[0].DropDownItems.Count; j++)
                        {
                            ToolStripItem item2 = items[0].DropDownItems[j];
                            item.DropDownItems.Add(item2);
                        }
 
                        return;
                    }
                }
 
                BrawlAPIInternal.ContextMenuHooks[wrapper] = BrawlAPIInternal.ContextMenuHooks[wrapper].Append(items);
            }
            else
            {
                BrawlAPIInternal.ContextMenuHooks.Add(wrapper, items);
            }
        }

AddContextMenuItem() [2/2]

static void BrawlCrate.API.BrawlAPI.AddContextMenuItem ( Type  wrapper, string  subMenuName, string  description, EventHandler  conditional, params ToolStripMenuItem[]  items  )

inlinestatic

To be called by API, adds context menu items to a wrapper with additional options.

Parameters

wrapper	The wrapper which new items will be added to.
subMenuName	(Optional) If not null or empty, a submenu which nodes will be defined under.
description	(Optional) If not null or empty, a string that will appear on mouseover. Will be added to the menu if the items are in a submenu, or added to all items otherwise.
conditional	(Optional) If not null, a function that will be run every time the dropdown is activated. Most useful to change an item's enabled state.
items	One or more ToolStrip menu items that will be added to the context menu. These should be defined as much as possible in the script itself.

        {
            if (conditional != null)
            {
                foreach (ToolStripMenuItem item in items)
                {
                    item.EnabledChanged += conditional;
                }
            }
 
            if (!string.IsNullOrEmpty(subMenuName))
            {
                ToolStripMenuItem t = new ToolStripMenuItem(subMenuName);
                foreach (ToolStripMenuItem item in items)
                {
                    t.DropDownItems.Add(item);
                }
 
                if (!string.IsNullOrEmpty(description))
                {
                    t.ToolTipText = description;
                }
 
                AddContextMenuItem(wrapper, t);
                return;
            }
 
            if (!string.IsNullOrEmpty(description))
            {
                foreach (ToolStripMenuItem item in items)
                {
                    item.ToolTipText += description;
                }
            }
 
            AddContextMenuItem(wrapper, items);
        }

AddMultiSelectContextMenuItem() [1/2]

static void BrawlCrate.API.BrawlAPI.AddMultiSelectContextMenuItem ( Type  wrapper, params ToolStripMenuItem[]  items  )

inlinestatic

To be called by API, adds context menu items to a wrapper's multi-selection menu.

The second definition for this function offers far more extensibility.

Parameters

wrapper	The wrapper which new items will be added to.
items	One or more ToolStrip menu items that will be added to the context menu. These should be defined as much as possible in the script itself.

        {
            if (BrawlAPIInternal.MultiSelectContextMenuHooks.ContainsKey(wrapper))
            {
                if (items.Length == 1 && items[0].HasDropDownItems)
                {
                    // Combine same-named submenus
                    for (int i = 0; i < BrawlAPIInternal.MultiSelectContextMenuHooks[wrapper].Length; i++)
                    {
                        ToolStripMenuItem item = BrawlAPIInternal.MultiSelectContextMenuHooks[wrapper][i];
                        if (!item.HasDropDownItems || item.Text != items[0].Text)
                        {
                            continue;
                        }
 
                        if (string.IsNullOrEmpty(item.ToolTipText))
                        {
                            item.ToolTipText = items[0].ToolTipText;
                        }
 
                        for (int j = 0; j < items[0].DropDownItems.Count; j++)
                        {
                            ToolStripItem item2 = items[0].DropDownItems[j];
                            item.DropDownItems.Add(item2);
                        }
 
                        return;
                    }
                }
 
                BrawlAPIInternal.MultiSelectContextMenuHooks[wrapper] =
                    BrawlAPIInternal.MultiSelectContextMenuHooks[wrapper].Append(items);
            }
            else
            {
                BrawlAPIInternal.MultiSelectContextMenuHooks.Add(wrapper, items);
            }
        }

AddMultiSelectContextMenuItem() [2/2]

static void BrawlCrate.API.BrawlAPI.AddMultiSelectContextMenuItem ( Type  wrapper, string  subMenuName, string  description, EventHandler  conditional, params ToolStripMenuItem[]  items  )

inlinestatic

To be called by API, adds context menu items to a wrapper's multi-selection menu with additional options.

Parameters

wrapper	The wrapper which new items will be added to.
subMenuName	(Optional) If not null or empty, a submenu which nodes will be defined under.
description	(Optional) If not null or empty, a string that will appear on mouseover. Will be added to the menu if the items are in a submenu, or added to all items otherwise.
conditional	(Optional) If not null, a function that will be run every time the dropdown is activated. Most useful to change an item's enabled state.
items	One or more ToolStrip menu items that will be added to the context menu. These should be defined as much as possible in the script itself.

        {
            if (conditional != null)
            {
                foreach (ToolStripMenuItem item in items)
                {
                    item.EnabledChanged += conditional;
                }
            }
 
            if (!string.IsNullOrEmpty(subMenuName))
            {
                ToolStripMenuItem t = new ToolStripMenuItem(subMenuName);
                foreach (ToolStripMenuItem item in items)
                {
                    t.DropDownItems.Add(item);
                }
 
                if (!string.IsNullOrEmpty(description))
                {
                    t.ToolTipText = description;
                }
 
                AddMultiSelectContextMenuItem(wrapper, t);
                return;
            }
 
            if (!string.IsNullOrEmpty(description))
            {
                foreach (ToolStripMenuItem item in items)
                {
                    item.ToolTipText += description;
                }
            }
 
            AddMultiSelectContextMenuItem(wrapper, items);
        }

AddResourceParser()

static void BrawlCrate.API.BrawlAPI.AddResourceParser ( PluginResourceParser  resourceParser )

inlinestatic

Adds parsing for a specific user-defined file type.

In bboxapi, this was originally "AddLoader"

Parameters

resourceParser

The PluginResourceParser to be added.

        {
            BrawlAPIInternal.ResourceParsers.Add(resourceParser);
        }

AddWrapper()

static void BrawlCrate.API.BrawlAPI.AddWrapper ( ResourceType  resourceType, PluginWrapper  wrapper  )

inlinestatic

Adds a wrapper for a specific user-defined file type.

This variation requires reference to a pre-existing ResourceType. Will overwrite pre-existing ResourceType-based wrappers.

Parameters

resourceType	The resource file type to attach the wrapper to.
wrapper	The wrapper to be used.

        {
            NodeWrapperAttribute.AddWrapper(resourceType, wrapper);
        }

AddWrapper< TypeNode >()

static void BrawlCrate.API.BrawlAPI.AddWrapper< TypeNode > ( PluginWrapper  wrapper )

inlinestatic

Adds a wrapper for a specific user-defined node type.

This variation bases wrappers off of the type of the resource node, offering more flexibility for new types. Will overwrite pre-existing Type-based wrappers. Type-based wrappers take priority over ResourceType-based wrappers.

Template Parameters

TypeNode

The ResourceNode type to attach the wrapper to.

Parameters

wrapper

The wrapper to be used.

Type Constraints

TypeNode

:

ResourceNode

                                                                                      : ResourceNode
        {
            NodeWrapperAttribute.AddWrapper<TypeNode>(wrapper);
        }

CloseFile()

static bool BrawlCrate.API.BrawlAPI.CloseFile ( )

inlinestatic

Closes the open file, leaving the editor on the idle screen.

If the open file has unsaved changes, prompts the user to save them.

Returns true if the file is successfully closed, and false otherwise.

        {
            return Program.Close();
        }

ForceCloseFile()

static bool BrawlCrate.API.BrawlAPI.ForceCloseFile ( )

inlinestatic

Closes the open file, leaving the editor on the idle screen.

Will close regardless of unsaved changes.

Returns true if the file is successfully closed, and false otherwise.

        {
            return Program.Close(true);
        }

New< T >()

static bool BrawlCrate.API.BrawlAPI.New< T > ( )

inlinestatic

Creates a new ResourceNode of type T and attempts to set it as the root node.

Template Parameters

T	The type of ResourceNode to create.

Returns

True if the file was successfully created, returns false otherwise.

Type Constraints

T

:

ResourceNode

                                            : ResourceNode
        {
            return Program.New<T>();
        }

NodeListOfType< T >()

static List< T > BrawlCrate.API.BrawlAPI.NodeListOfType< T > ( )

inlinestatic

Returns a full list of all nodes of a given type in the open file.

Returns an empty list if there is no open file

Type Constraints

T

:

ResourceNode

                                                          : ResourceNode
        {
            List<T> nodes = new List<T>();
 
            foreach (ResourceNode node in NodeList)
            {
                if (node is T typedNode)
                {
                    nodes.Add(typedNode);
                }
            }
 
            return nodes;
        }

NodeWrapperListOfType< T >()

static List< T > BrawlCrate.API.BrawlAPI.NodeWrapperListOfType< T > ( )

inlinestatic

Returns a full list of all node wrappers of a given type in the open file.

Returns an empty list if there is no open file

Type Constraints

T

:

BaseWrapper

                                                                 : BaseWrapper
        {
            List<T> wrappers = new List<T>();
 
            foreach (BaseWrapper wrapper in NodeWrapperList)
            {
                if (wrapper is T typedWrapper)
                {
                    wrappers.Add(typedWrapper);
                }
            }
 
            return wrappers;
        }

OpenFile()

static bool BrawlCrate.API.BrawlAPI.OpenFile ( string  path )

inlinestatic

Attempts to open the file using a given path.

Parameters

path	The path of the file that is to be opened.

Returns

True if the file is successfully loaded, and false otherwise.

        {
            return Program.Open(path);
        }

OpenFileDialog() [1/3]

static string BrawlCrate.API.BrawlAPI.OpenFileDialog ( )

inlinestatic

Opens an open file dialog, prompting the user to select a file.

Returns the path of the file that the user chose, or an empty string if the dialog was cancelled.

        {
            using (OpenFileDialog dlg = new OpenFileDialog())
            {
                dlg.Title = "Open File";
                dlg.Multiselect = false;
                return dlg.ShowDialog() == DialogResult.OK ? dlg.FileName : string.Empty;
            }
        }

OpenFileDialog() [2/3]

static string BrawlCrate.API.BrawlAPI.OpenFileDialog ( string  title )

inlinestatic

Opens an open file dialog, prompting the user to select a file.

Returns the path of the file that the user chose, or an empty string if the dialog was cancelled.

Parameters

title

The title text that will show in the TitleBar of the form.

        {
            using (OpenFileDialog dlg = new OpenFileDialog())
            {
                dlg.Multiselect = false;
                dlg.Title = title;
                return dlg.ShowDialog() == DialogResult.OK ? dlg.FileName : string.Empty;
            }
        }

OpenFileDialog() [3/3]

static string BrawlCrate.API.BrawlAPI.OpenFileDialog ( string  title, string  filter  )

inlinestatic

Opens an open file dialog, prompting the user to select a file.

Returns the path of the file that the user chose, or an empty string if the dialog was cancelled.

Parameters

title	The title text that will show in the TitleBar of the form.
filter	The file filter to use for the open file dialog. Use the formatting found here: https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.filedialog.filter

You can also reference the pre-programmed filters from FileFilters.cs

        {
            using (OpenFileDialog dlg = new OpenFileDialog())
            {
                dlg.Multiselect = false;
                dlg.Title = title;
                dlg.Filter = filter;
                return dlg.ShowDialog() == DialogResult.OK ? dlg.FileName : string.Empty;
            }
        }

OpenFileNoErrors()

static bool BrawlCrate.API.BrawlAPI.OpenFileNoErrors ( string  path )

inlinestatic

Attempts to open the file using a given path. Any error messages (including "file not found") are not shown to the user.

Parameters

path	The path of the file that is to be opened.

Returns

True if the file is successfully loaded, and false otherwise.

        {
            return Program.Open(path, false);
        }

OpenFolderDialog() [1/2]

static string BrawlCrate.API.BrawlAPI.OpenFolderDialog ( )

inlinestatic

Opens an Open Folder Dialog, prompting the user to select a folder.

Returns the path of the folder that the user chose, or an empty string if the dialog was cancelled.

        {
#if !MONO
            using (VistaFolderBrowserDialog dlg = new VistaFolderBrowserDialog {UseDescriptionForTitle = true})
#else
            using (FolderBrowserDialog dlg = new FolderBrowserDialog())
#endif
            {
                dlg.Description = "Open Folder";
                return dlg.ShowDialog() == DialogResult.OK ? dlg.SelectedPath : string.Empty;
            }
        }

OpenFolderDialog() [2/2]

static string BrawlCrate.API.BrawlAPI.OpenFolderDialog ( string  description )

inlinestatic

Opens an Open Folder Dialog, prompting the user to select a folder.

Returns the path of the folder that the user chose, or an empty string if the dialog was cancelled.

Parameters

description

The description of the folder dialog.

For Windows-based devices, this will appear as the title of the window. For others, this will appear as a description box.

        {
#if !MONO
            using (VistaFolderBrowserDialog dlg = new VistaFolderBrowserDialog {UseDescriptionForTitle = true})
#else
            using (FolderBrowserDialog dlg = new FolderBrowserDialog())
#endif
            {
                dlg.Description = description;
                return dlg.ShowDialog() == DialogResult.OK ? dlg.SelectedPath : string.Empty;
            }
        }

OpenMultiFileDialog() [1/3]

static string[] BrawlCrate.API.BrawlAPI.OpenMultiFileDialog ( )

inlinestatic

Opens an open file dialog, prompting the user to select multiple files

Returns the paths of the files that the user chose, or null if the dialog was cancelled.

        {
            using (OpenFileDialog dlg = new OpenFileDialog())
            {
                dlg.Title = "Open Files";
                dlg.Multiselect = true;
                return dlg.ShowDialog() == DialogResult.OK ? dlg.FileNames : null;
            }
        }

OpenMultiFileDialog() [2/3]

static string[] BrawlCrate.API.BrawlAPI.OpenMultiFileDialog ( string  title )

inlinestatic

Opens an open file dialog, prompting the user to select multiple files

Returns the paths of the files that the user chose, or null if the dialog was cancelled.

Parameters

title

The title text that will show in the TitleBar of the form.

        {
            using (OpenFileDialog dlg = new OpenFileDialog())
            {
                dlg.Multiselect = true;
                dlg.Title = title;
                return dlg.ShowDialog() == DialogResult.OK ? dlg.FileNames : null;
            }
        }

OpenMultiFileDialog() [3/3]

static string[] BrawlCrate.API.BrawlAPI.OpenMultiFileDialog ( string  title, string  filter  )

inlinestatic

Opens an open file dialog, prompting the user to select multiple files

Returns the paths of the files that the user chose, or null if the dialog was cancelled.

Parameters

title	The title text that will show in the TitleBar of the form.
filter	The file filter to use for the open file dialog. Use the formatting found here: https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.filedialog.filter

You can also reference the pre-programmed filters from FileFilters.cs

        {
            using (OpenFileDialog dlg = new OpenFileDialog())
            {
                dlg.Multiselect = true;
                dlg.Title = title;
                dlg.Filter = filter;
                return dlg.ShowDialog() == DialogResult.OK ? dlg.FileNames : null;
            }
        }

OpenTemplate()

static bool BrawlCrate.API.BrawlAPI.OpenTemplate ( string  path )

inlinestatic

Attempts to open the file as a template using a given path.

Templates do not set the save path, meaning that the user will be prompted for "Save As" on first save.

Returns true if the file is successfully loaded, and false otherwise.

Parameters

path	The path of the template file that is to be opened.

        {
            return Program.OpenTemplate(path);
        }

OpenTemplateNoErrors()

static bool BrawlCrate.API.BrawlAPI.OpenTemplateNoErrors ( string  path )

inlinestatic

Attempts to open the file using a given path. Any error messages (including "file not found") are not shown to the user.

Templates do not set the save path, meaning that the user will be prompted for "Save As" on first save.

Returns true if the file is successfully loaded, and false otherwise.

Parameters

path	The path of the template file that is to be opened.

        {
            return Program.OpenTemplate(path, false);
        }

RefreshPreview()

static void BrawlCrate.API.BrawlAPI.RefreshPreview ( )

inlinestatic

Refreshes the preview on the main window.

        {
            MainForm.Instance.resourceTree_SelectionChanged(null, null);
        }

SaveFile()

static bool BrawlCrate.API.BrawlAPI.SaveFile ( )

inlinestatic

Attempts to save the opened file.

Returns true if the file is successfully saved, and false otherwise.

        {
            return Program.Save(false);
        }

SaveFileAs() [1/2]

static bool BrawlCrate.API.BrawlAPI.SaveFileAs ( )

inlinestatic

Prompts the user to save the open file to a directory.

Returns true if the file is successfully saved, and false otherwise.

        {
            return Program.SaveAs();
        }

SaveFileAs() [2/2]

static bool BrawlCrate.API.BrawlAPI.SaveFileAs ( string  path )

inlinestatic

Attempts to save the opened file to a given path.

Returns true if the file is successfully saved, and false otherwise.

Parameters

path	The path to which the file should be saved

        {
            try
            {
                MainForm.Instance?.RootNode.Resource.Export(path);
                Program._rootPath = path;
                MainForm.Instance?.UpdateName();
            }
            catch (Exception e)
            {
                MessageBox.Show(e.Message, "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
                return false;
            }
 
            return true;
        }

SaveFileDialog() [1/3]

static string BrawlCrate.API.BrawlAPI.SaveFileDialog ( )

inlinestatic

Opens a save file dialog, prompting the user to save a file.

DOES NOT ACTUALLY SAVE ANYTHING BY ITSELF! Additional scripting must be done if you want to actually save anything.

Returns the save path that the user chose, or an empty string if the dialog was cancelled.

        {
            using (SaveFileDialog dlg = new SaveFileDialog())
            {
                return dlg.ShowDialog() == DialogResult.OK ? dlg.FileName : string.Empty;
            }
        }

SaveFileDialog() [2/3]

static string BrawlCrate.API.BrawlAPI.SaveFileDialog ( string  title )

inlinestatic

Opens a save file dialog, prompting the user to save a file.

DOES NOT ACTUALLY SAVE ANYTHING BY ITSELF! Additional scripting must be done if you want to actually save anything.

Returns the save path that the user chose, or an empty string if the dialog was cancelled.

Parameters

title

The title text that will show in the TitleBar of the form.

        {
            using (SaveFileDialog dlg = new SaveFileDialog())
            {
                dlg.Title = title;
                return dlg.ShowDialog() == DialogResult.OK ? dlg.FileName : string.Empty;
            }
        }

SaveFileDialog() [3/3]

static string BrawlCrate.API.BrawlAPI.SaveFileDialog ( string  title, string  filter  )

inlinestatic

Opens a save file dialog, prompting the user to save a file.

DOES NOT ACTUALLY SAVE ANYTHING BY ITSELF! Additional scripting must be done if you want to actually save anything.

Returns the save path that the user chose, or an empty string if the dialog was cancelled.

Parameters

title	The title text that will show in the TitleBar of the form.
filter	The file filter to use for the open file dialog. Use the formatting found here: https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.filedialog.filter

You can also reference the pre-programmed filters from FileFilters.cs

        {
            using (SaveFileDialog dlg = new SaveFileDialog())
            {
                dlg.Title = title;
                dlg.Filter = filter;
                return dlg.ShowDialog() == DialogResult.OK ? dlg.FileName : string.Empty;
            }
        }

ShowError()

static void BrawlCrate.API.BrawlAPI.ShowError ( string  msg, string  title  )

inlinestatic

Shows a MessageBox with the given message and title, the default "OK" option, and an Error symbol.

Doesn't return a value, and is just used to show the user messages.

Parameters

msg	The message that will appear in the body of the MessageBox.
title	The title text that will show in the TitleBar of the MessageBox.

        {
            MessageBox.Show(MainForm.Instance, msg, title, MessageBoxButtons.OK, MessageBoxIcon.Error);
        }

ShowMessage()

static void BrawlCrate.API.BrawlAPI.ShowMessage ( string  msg, string  title  )

inlinestatic

Shows a MessageBox with the given message and title, and the default "OK" option.

Doesn't return a value, and is just used to show the user messages.

Parameters

msg	The message that will appear in the body of the MessageBox.
title	The title text that will show in the TitleBar of the MessageBox.

        {
            MessageBox.Show(MainForm.Instance, msg, title);
        }

ShowOKCancelError()

static bool BrawlCrate.API.BrawlAPI.ShowOKCancelError ( string  msg, string  title  )

inlinestatic

Shows a MessageBox with the given message and title, "OK/Cancel" options, and an Error symbol.

Returns true if "OK" is clicked, and false otherwise.

Parameters

msg	The message that will appear in the body of the MessageBox.
title	The title text that will show in the TitleBar of the MessageBox.

        {
            return MessageBox.Show(MainForm.Instance, msg, title, MessageBoxButtons.OKCancel, MessageBoxIcon.Error)
                   == DialogResult.OK;
        }

ShowOKCancelPrompt()

static bool BrawlCrate.API.BrawlAPI.ShowOKCancelPrompt ( string  msg, string  title  )

inlinestatic

Shows a MessageBox with the given message and title, with options for "OK" or "Cancel".

Returns true if "OK" is clicked, and false otherwise.

Parameters

msg	The message that will appear in the body of the MessageBox.
title	The title text that will show in the TitleBar of the MessageBox.

        {
            return MessageBox.Show(MainForm.Instance, msg, title, MessageBoxButtons.OKCancel) == DialogResult.OK;
        }

ShowOKCancelWarning()

static bool BrawlCrate.API.BrawlAPI.ShowOKCancelWarning ( string  msg, string  title  )

inlinestatic

Shows a MessageBox with the given message and title, "OK/Cancel" options, and a Warning symbol.

Returns true if "OK" is clicked, and false otherwise.

Parameters

msg	The message that will appear in the body of the MessageBox.
title	The title text that will show in the TitleBar of the MessageBox.

        {
            return MessageBox.Show(MainForm.Instance, msg, title, MessageBoxButtons.OKCancel, MessageBoxIcon.Warning)
                   == DialogResult.OK;
        }

ShowWarning()

static void BrawlCrate.API.BrawlAPI.ShowWarning ( string  msg, string  title  )

inlinestatic

Shows a MessageBox with the given message and title, the default "OK" option, and a Warning symbol.

Doesn't return a value, and is just used to show the user messages.

Parameters

msg	The message that will appear in the body of the MessageBox.
title	The title text that will show in the TitleBar of the MessageBox.

        {
            MessageBox.Show(MainForm.Instance, msg, title, MessageBoxButtons.OK, MessageBoxIcon.Warning);
        }

ShowYesNoError()

static bool BrawlCrate.API.BrawlAPI.ShowYesNoError ( string  msg, string  title  )

inlinestatic

Shows a MessageBox with the given message and title, "Yes/No" options, and an Error symbol.

Returns true if "Yes" is clicked, and false otherwise.

Parameters

msg	The message that will appear in the body of the MessageBox.
title	The title text that will show in the TitleBar of the MessageBox.

        {
            return MessageBox.Show(MainForm.Instance, msg, title, MessageBoxButtons.YesNo, MessageBoxIcon.Error)
                   == DialogResult.Yes;
        }

ShowYesNoPrompt()

static bool BrawlCrate.API.BrawlAPI.ShowYesNoPrompt ( string  msg, string  title  )

inlinestatic

Shows a MessageBox with the given message and title, with options for "Yes" or "No".

Returns true if "Yes" is clicked, and false otherwise.

Parameters

msg	The message that will appear in the body of the MessageBox.
title	The title text that will show in the TitleBar of the MessageBox.

        {
            return MessageBox.Show(MainForm.Instance, msg, title, MessageBoxButtons.YesNo) == DialogResult.Yes;
        }

ShowYesNoWarning()

static bool BrawlCrate.API.BrawlAPI.ShowYesNoWarning ( string  msg, string  title  )

inlinestatic

Shows a MessageBox with the given message and title, "Yes/No" options, and a Warning symbol.

Returns true if "Yes" is clicked, and false otherwise.

Parameters

msg	The message that will appear in the body of the MessageBox.
title	The title text that will show in the TitleBar of the MessageBox.

        {
            return MessageBox.Show(MainForm.Instance, msg, title, MessageBoxButtons.YesNo, MessageBoxIcon.Warning)
                   == DialogResult.Yes;
        }

UserFloatInput() [1/5]

static float BrawlCrate.API.BrawlAPI.UserFloatInput ( string  title )

inlinestatic

Prompts the user to input a float.

Parameters

title

The title of the dialog box

Returns

The user-inputted float

        {
            return UserFloatInput(title, "Value:", _lastFloatInput, float.MinValue, float.MaxValue);
        }

UserFloatInput() [2/5]

static float BrawlCrate.API.BrawlAPI.UserFloatInput ( string  title, string  description  )

inlinestatic

Prompts the user to input a float.

Parameters

title	The title of the dialog box
description	A short description printed next to the NumericEntryBox

Returns

The user-inputted float

        {
            return UserFloatInput(title, description, _lastFloatInput, float.MinValue, float.MaxValue);
        }

UserFloatInput() [3/5]

static float BrawlCrate.API.BrawlAPI.UserFloatInput ( string  title, string  description, float  defaultValue  )

inlinestatic

Prompts the user to input a float.

Parameters

title	The title of the dialog box
description	A short description printed next to the NumericEntryBox
defaultValue	The default value that the NumericInputBox will be set to

Returns

The user-inputted float

        {
            return UserFloatInput(title, description, defaultValue, float.MinValue, float.MaxValue);
        }

UserFloatInput() [4/5]

static float BrawlCrate.API.BrawlAPI.UserFloatInput ( string  title, string  description, float  defaultValue, float  minimumValue  )

inlinestatic

Prompts the user to input a float.

Parameters

title	The title of the dialog box
description	A short description printed next to the NumericEntryBox
defaultValue	The default value that the NumericInputBox will be set to
minimumValue	The lowest possible number allowed

Returns

The user-inputted float

        {
            return UserFloatInput(title, description, defaultValue, minimumValue, float.MaxValue);
        }

UserFloatInput() [5/5]

static float BrawlCrate.API.BrawlAPI.UserFloatInput ( string  title, string  description, float  defaultValue, float  minimumValue, float  maximumValue  )

inlinestatic

Prompts the user to input a float.

Parameters

title	The title of the dialog box
description	A short description printed next to the NumericEntryBox
defaultValue	The default value that the NumericInputBox will be set to
minimumValue	The lowest possible number allowed
maximumValue	The highest possible number allowed

Returns

The user-inputted float

        {
            using (NumericInputForm dialog = new NumericInputForm())
            {
                dialog.Cancellable = false;
                dialog.numNewCount.Integer = false;
                dialog.numNewCount.Integral = false;
                // Set minimum and maximum values if applicable
                if (minimumValue != maximumValue)
                {
                    dialog.numNewCount.MinimumValue = minimumValue;
                    dialog.numNewCount.MaximumValue = maximumValue;
                    // Ensure value stays within the boundaries set
                    if (defaultValue < minimumValue || defaultValue > maximumValue)
                    {
                        defaultValue = minimumValue;
                    }
                }
                else
                {
                    dialog.numNewCount.MinimumValue = float.MinValue;
                    dialog.numNewCount.MaximumValue = float.MaxValue;
                }
 
                dialog.ShowDialog(title, description, defaultValue);
                _lastFloatInput = dialog.NewFloatValue;
                return dialog.NewFloatValue;
            }
        }

UserIntegerInput() [1/6]

static int BrawlCrate.API.BrawlAPI.UserIntegerInput ( )

inlinestatic

Prompts the user to input an integer.

Returns

The user-inputted integer

        {
            return UserIntegerInput("BrawlAPI Integer Input", "Value:", _lastIntegerInput, 0, 0);
        }

UserIntegerInput() [2/6]

static int BrawlCrate.API.BrawlAPI.UserIntegerInput ( string  title )

inlinestatic

Prompts the user to input an integer.

Parameters

title

The title of the dialog box

Returns

The user-inputted integer

        {
            return UserIntegerInput(title, "Value:", _lastIntegerInput, 0, 0);
        }

UserIntegerInput() [3/6]

static int BrawlCrate.API.BrawlAPI.UserIntegerInput ( string  title, string  description  )

inlinestatic

Prompts the user to input an integer.

Parameters

title	The title of the dialog box
description	A short description printed next to the NumericEntryBox

Returns

The user-inputted integer

        {
            return UserIntegerInput(title, description, _lastIntegerInput, 0, 0);
        }

UserIntegerInput() [4/6]

static int BrawlCrate.API.BrawlAPI.UserIntegerInput ( string  title, string  description, int  defaultValue  )

inlinestatic

Prompts the user to input an integer.

Parameters

title	The title of the dialog box
description	A short description printed next to the NumericEntryBox
defaultValue	The default value that the NumericInputBox will be set to

Returns

The user-inputted integer

        {
            return UserIntegerInput(title, description, defaultValue, 0, 0);
        }

UserIntegerInput() [5/6]

static int BrawlCrate.API.BrawlAPI.UserIntegerInput ( string  title, string  description, int  defaultValue, int  minimumValue  )

inlinestatic

Prompts the user to input an integer.

Parameters

title	The title of the dialog box
description	A short description printed next to the NumericEntryBox
defaultValue	The default value that the NumericInputBox will be set to
minimumValue	The lowest possible number allowed

Returns

The user-inputted integer

        {
            return UserIntegerInput(title, description, defaultValue, minimumValue, int.MaxValue);
        }

UserIntegerInput() [6/6]

static int BrawlCrate.API.BrawlAPI.UserIntegerInput ( string  title, string  description, int  defaultValue, int  minimumValue, int  maximumValue  )

inlinestatic

Prompts the user to input an integer.

Parameters

title	The title of the dialog box
description	A short description printed next to the NumericEntryBox
defaultValue	The default value that the NumericInputBox will be set to
minimumValue	The lowest possible number allowed
maximumValue	The highest possible number allowed

Returns

The user-inputted integer

        {
            using (NumericInputForm dialog = new NumericInputForm())
            {
                dialog.Cancellable = false;
                dialog.numNewCount.Integer = true;
                // Set minimum and maximum values if applicable
                if (minimumValue != maximumValue)
                {
                    dialog.numNewCount.MinimumValue = minimumValue;
                    dialog.numNewCount.MaximumValue = maximumValue;
                    // Ensure value stays within the boundaries set
                    if (defaultValue < minimumValue || defaultValue > maximumValue)
                    {
                        defaultValue = minimumValue;
                    }
                }
 
                dialog.ShowDialog(title, description, defaultValue);
                _lastIntegerInput = dialog.NewValue;
                return dialog.NewValue;
            }
        }

UserStringInput() [1/3]

static string BrawlCrate.API.BrawlAPI.UserStringInput ( )

inlinestatic

Prompts the user to input a string, with a default title and the last BrawlAPI-entered string as the default value.

Returns

The user-inputted string

        {
            return UserStringInput("BrawlAPI String Input", _lastStringInput);
        }

UserStringInput() [2/3]

static string BrawlCrate.API.BrawlAPI.UserStringInput ( string  title )

inlinestatic

Prompts the user to input a string, with the last BrawlAPI-entered string as the default value.

Parameters

title

The title of the string input dialog box

Returns

The user-inputted string

        {
            return UserStringInput(title, _lastStringInput);
        }

UserStringInput() [3/3]

static string BrawlCrate.API.BrawlAPI.UserStringInput ( string  title, string  defaultText  )

inlinestatic

Prompts the user to input a string with a default starting value.

Parameters

title	The title of the string input dialog box
defaultText	The default text to use for the input

Returns

The user-inputted string

        {
            using (StringInputDialog dialog = new StringInputDialog(title, defaultText))
            {
                dialog.Cancellable = false;
                dialog.ShowDialog();
                _lastStringInput = dialog.resultString;
                return dialog.resultString;
            }
        }

Wait()

static void BrawlCrate.API.BrawlAPI.Wait ( int  milliseconds )

inlinestatic

Causes the current thread to sleep for a number of milliseconds.

Parameters

milliseconds

The amount of time to wait, in milliseconds

        {
            System.Threading.Thread.Sleep(milliseconds);
        }

WriteToConsole()

static void BrawlCrate.API.BrawlAPI.WriteToConsole ( string  msg )

inlinestatic

Writes a message to the the console and debug log (if debugging) and the Trace log (if enabled).

To be used for debugging purposes only. This function call will do nothing in release builds. For compatibility purposes, this function will still be callable in release builds.

Parameters

msg	The string to be written to the console.

        {
#if DEBUG
            Console.WriteLine(msg);
            System.Diagnostics.Debug.WriteLine(msg);
#endif
#if TRACE
            System.Diagnostics.Trace.WriteLine(msg);
#endif
        }

Property Documentation

APIPath

string BrawlCrate.API.BrawlAPI.APIPath

staticget

The folder in which the API folders are located.

AppPath

string BrawlCrate.API.BrawlAPI.AppPath

staticget

The folder in which the BrawlCrate installation is located.

LibPath

string BrawlCrate.API.BrawlAPI.LibPath

staticget

The folder in which API libraries are located.

LoaderPath

string BrawlCrate.API.BrawlAPI.LoaderPath

staticget

The folder in which loaders are located.

NodeList

List<ResourceNode> BrawlCrate.API.BrawlAPI.NodeList

staticget

Returns a full list of all nodes in the open file.

Returns an empty list if there is no open file.

        {
            get
            {
                List<ResourceNode> nodes = new List<ResourceNode>();
 
                if (RootNode != null)
                {
                    nodes.AddRange(ResourceNode.FindAllSubNodes(RootNode));
                }
 
                return nodes;
            }
        }

NodeWrapperList

List<BaseWrapper> BrawlCrate.API.BrawlAPI.NodeWrapperList

staticget

Returns a full list of all node wrappers in the open file.

Note that this function is generally slow due to the implementation of ResourceTrees; for general usage, NodeList works best.

Returns an empty list if there is no open file.

        {
            get
            {
                List<BaseWrapper> wrappers = new List<BaseWrapper>();
 
                if (RootNodeWrapper != null)
                {
                    MainForm.Instance?.resourceTree.Hide();
 
                    TreeNodeCollection treeNodes = RootNodeWrapper.TreeView.Nodes;
                    foreach (TreeNode n in treeNodes)
                    {
                        if (n is BaseWrapper b)
                        {
                            wrappers.AddRange(BaseWrapper.GetAllNodes(b));
                        }
                    }
 
                    MainForm.Instance?.resourceTree.Show();
                }
 
                return wrappers;
            }
        }

PluginPath

string BrawlCrate.API.BrawlAPI.PluginPath

staticget

The folder in which plugins are located.

ResourcesPath

string BrawlCrate.API.BrawlAPI.ResourcesPath

staticget

The folder in which API resources are located.

RootNode

ResourceNode BrawlCrate.API.BrawlAPI.RootNode

staticget

The root node of the opened file.

Returns

The current Root Node, or null if there is no current nodetree.

RootNodeWrapper

BaseWrapper BrawlCrate.API.BrawlAPI.RootNodeWrapper

staticget

The wrapper for the root node of the opened file.

Returns null if there is no open file.

SelectedNode

ResourceNode BrawlCrate.API.BrawlAPI.SelectedNode

staticget

The currently selected node on the Main Form. Useful for context menu items.

Returns

The currently selected node, or null if no node is currently selected.

SelectedNodes

List<ResourceNode> BrawlCrate.API.BrawlAPI.SelectedNodes

staticget

The currently selected nodes on the Main Form.

Returns

A list of all current selected nodes, or an empty list if no nodes are selected.

        {
            get
            {
                List<ResourceNode> nodes = new List<ResourceNode>();
                if (MainForm.Instance?.resourceTree.SelectedNodes != null)
                {
                    foreach (BaseWrapper b in MainForm.Instance?.resourceTree.SelectedNodes)
                    {
                        nodes.Add(b.Resource);
                    }
                }
 
                return nodes;
            }
        }

SelectedNodeWrapper

BaseWrapper BrawlCrate.API.BrawlAPI.SelectedNodeWrapper

staticget

The wrapper for the currently selected node on the Main Form. Useful for context menu items.

Returns null if there is no selected node.

SelectedNodeWrappers

List<BaseWrapper> BrawlCrate.API.BrawlAPI.SelectedNodeWrappers

staticget

The wrappers for the currently selected nodes on the Main Form.

Returns null if there are no selected nodes.

        {
            get
            {
                List<BaseWrapper> wrappers = new List<BaseWrapper>();
                if (MainForm.Instance?.resourceTree.SelectedNodes != null)
                {
                    foreach (TreeNode treeNode in MainForm.Instance?.resourceTree.SelectedNodes)
                    {
                        if (treeNode is BaseWrapper b)
                        {
                            wrappers.Add(b);
                        }
                    }
                }
 
                return wrappers;
            }
        }

---

The documentation for this class was generated from the following file:

• BrawlCrate/API/ExposedMembers.cs