The AddHelpers method is a virtual method of the BaseModelDocAttribute class within the Sandbox.ModelEditor.Internal namespace. This method is designed to add helper information to a list of tuples, where each tuple consists of a string and an array of strings. This can be useful for extending or providing additional metadata or documentation for model attributes in the Sandbox model editor.
To use the AddHelpers method, you need to have an instance of a class that derives from BaseModelDocAttribute. You can then call this method, passing a list of tuples as the parameter. Each tuple should contain a string key and an array of string values that represent the helper information you want to add.
This method is virtual, so it can be overridden in derived classes to provide specific behavior for adding helpers.
// Example of using AddHelpers method
public class CustomModelDocAttribute : BaseModelDocAttribute
{
public override void AddHelpers(List<Tuple<string, string[]>> helpers)
{
// Add custom helper information
helpers.Add(new Tuple<string, string[]>("ExampleKey", new string[] { "Helper1", "Helper2" }));
}
}
// Usage
var customAttribute = new CustomModelDocAttribute();
var helpersList = new List<Tuple<string, string[]>>();
customAttribute.AddHelpers(helpersList);
// helpersList now contains the added helper information