Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

ILogger

Provides a common interface to logging during source gen to support any different type of logger. Technically for the source gen system but I suppose anything can use it...
public interface ILogger
Logging is extremely intensive and will generate enormous logs very quickly due to the nature of how source generators and analysers work. You almost certainly do not need this interface, nor type conforming to it, and if you do beware here be dragons.

#Methods

#Dec()

Decrement the current depth of the logger
void Dec();

Returns Void

#Inc()

Increment the current depth of the logger
void Inc();

Returns Void

#WriteException(System.Exception, string?)

Logs an exception encountered during
void WriteException(System.Exception ex, string? message = null);

Parameters

  • exSystem.Exception
    The exception to be logged
  • messagestring?
    An optional message to go along with it

Returns Void

#WriteLine(object)

The standard "write a single line containing the value" of a logger.
void WriteLine(object obj);

Parameters

  • objobject
    The value to be written, will generally always be a string

Returns Void

This line should be indented by the current depth of the logger

Generated from Yarn Spinner for Unity 3.3.