ModDebugHandler Class |
A ModDebugHandler is a dedicated log handler which is associated with a ModHost and can be used to log messages in a mod specific context.
You are also able to register any number of log receivers to handle how the logged data is used.
Inheritance HierarchyNamespace: UMod.Debugging
Assembly: UMod (in UMod.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public sealed class ModDebugHandler : IModDebug
The ModDebugHandler type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ReceiverCount |
Get the number of IModDebugReceiver registered with this handler.
|
| Receivers |
Get an enumerable collection of all registered IModDebugReceiver instances.
|
| UseStackTrace |
Should the handler generate a stack trace for each logged message.
By default, stack traces are enabled.
note that generating a stack trace for each log message will have an small impact on performance.
|
Methods| Name | Description | |
|---|---|---|
 | AddReceiver |
Add the specified IModDebugReceiver to this handler in order to recieve logged messages.
|
| LogError(String) |
Log an error to the debug handler.
|
| LogError(String, Object) |
Log an error to the debug handler.
|
| LogException |
Log an exception to the debug handler.
|
| LogMessage(String) |
Log a message to the debug handler.
|
| LogMessage(String, Object) |
Log a message to the debug handler.
|
| LogWarning(String) |
Log a warning to the debug handler.
|
| LogWarning(String, Object) |
Log a warning to the debug handler.
|
| RemoveAllReceivers |
Causes all registered IModDebugReceiver instances to be removed from this handler.
|
| RemoveReceiver |
Remove the specified IModDebugReceiver from this handler.
|
See Also