GH_DebugDescriptionWriter

References
public class GH_DebugDescriptionWriter
Writer object used to create debug logs.

Constructors

GH_DebugDescriptionWriter

#
public GH_DebugDescriptionWriter()

Properties

Depth

#
public int Depth { get; }
Gets the depth of the current writer. Depth is represented by whitespace in front of each line.

Methods

CloseBlock

#
public void CloseBlock()
Close the current block and decrease the depth by 1.

CreateBlock

#
public void CreateBlock(string name)
Begin a new block. This will increase the depth by 1. You must call CloseBlock() if you call this function.
Parameters:
name (string)

CreateLog

#
public string CreateLog()
Get a single string that represents the entire log so far.

WriteLine

#
public void WriteLine()
Write a new blank line to the log.

WriteLine

#
public void WriteLine(string line, params object[] args)
Write a new formatted line to the log.
Parameters:
line (string)Line to write with formatting tags.
args (params object[])Data to format.

WriteLine

#
public void WriteLine(string line)
Write a new line to the log.
Parameters:
line (string)Line to write.

WriteLogToFile

#
public bool WriteLogToFile(string path)
Write the log to a text file.
Parameters:
path (string)Path of file to write to.
Returns: True on success, false on failure.