SR Squad Manager Plugin Interfaces
 All Classes Namespaces Functions Properties
Public Member Functions | List of all members
SquadManagerPluginInterfaces.ISquadManagerPlugin Interface Reference

Public Member Functions

string GetLocalizedName (System.Globalization.CultureInfo culture)
 Return the name for this plugin for the given culture. It is recommended to store the culture information to translate other strings, as this is the active UI language.
 
System.Windows.Forms.UserControl GetUI ()
 Return the UI control that will be shown for the plugin. The basic frame with closing functionality and simple author information is provided. This function will be called only once shortly after initializing the plugin, so design your UI in a way that it can be reused every time the plugin window opens.
 
void ReceiveCallbackInterface (ISquadManagerPluginCallback cb)
 This function will be called only once shortly after initializing the plugin to provide the callback interface. This should be stored for future usage.
 
bool EventGlitchHappened (ISquadManagerCharacterInterface actor, bool critical, string context)
 This function is called every time an actor throws a glitch. The string context should provide some additional information about the situation, where the glitch happened (e.g. a skill name or something like "healing"), but can be null if this information is not available. You should return TRUE if you want the plugin window to open (which is not guaranteed, though) or FALSE otherwise. If you don't want to handle glitches, just always return FALSE.
 
bool EventDamageSuffered (ISquadManagerCharacterInterface actor)
 This function is called every time an actor's damage changes (i.e. does not completely dodge the attack or resist all the damage OR gets healed). You should return TRUE if you want the plugin window to open (which is not guaranteed, though) or FALSE otherwise. If you don't want to handle damage eventy, just always return FALSE.
 

Member Function Documentation

bool SquadManagerPluginInterfaces.ISquadManagerPlugin.EventDamageSuffered ( ISquadManagerCharacterInterface  actor)

This function is called every time an actor's damage changes (i.e. does not completely dodge the attack or resist all the damage OR gets healed). You should return TRUE if you want the plugin window to open (which is not guaranteed, though) or FALSE otherwise. If you don't want to handle damage eventy, just always return FALSE.

Parameters
actorThe actor that suffered damage
Returns
TRUE if you request the plugin window to open, FALSE otherwise
bool SquadManagerPluginInterfaces.ISquadManagerPlugin.EventGlitchHappened ( ISquadManagerCharacterInterface  actor,
bool  critical,
string  context 
)

This function is called every time an actor throws a glitch. The string context should provide some additional information about the situation, where the glitch happened (e.g. a skill name or something like "healing"), but can be null if this information is not available. You should return TRUE if you want the plugin window to open (which is not guaranteed, though) or FALSE otherwise. If you don't want to handle glitches, just always return FALSE.

Parameters
actorThe actor that glitched
criticalTRUE if the glitch was critical, FALSE otherwise
contextAdditional information to describe the context, in which the glitch happened, or null if no further information is available.
Returns
TRUE if you request the plugin window to open, FALSE otherwise
string SquadManagerPluginInterfaces.ISquadManagerPlugin.GetLocalizedName ( System.Globalization.CultureInfo  culture)

Return the name for this plugin for the given culture. It is recommended to store the culture information to translate other strings, as this is the active UI language.

Parameters
cultureThe current UI culture
System.Windows.Forms.UserControl SquadManagerPluginInterfaces.ISquadManagerPlugin.GetUI ( )

Return the UI control that will be shown for the plugin. The basic frame with closing functionality and simple author information is provided. This function will be called only once shortly after initializing the plugin, so design your UI in a way that it can be reused every time the plugin window opens.

Returns
void SquadManagerPluginInterfaces.ISquadManagerPlugin.ReceiveCallbackInterface ( ISquadManagerPluginCallback  cb)

This function will be called only once shortly after initializing the plugin to provide the callback interface. This should be stored for future usage.

Parameters
cbThe interface object for all further funtionality

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