Class CustomReportData

Namespace

SuzerainModdingKit.Report

Assembly

SuzerainModdingKit.dll

Represents the data required to define a custom report for injection into the game.

public class CustomReportData

Inheritance

object

CustomReportData

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CustomReportData(string, StoryPackInfo, string, string, string)

Creates a new instance of this class.

public CustomReportData(string name, StoryPackInfo storyPack, string assignedTokenName, string title, string description)

Parameters

name string

The unique identifier of this report.

storyPack StoryPackInfo

The story pack that this report should appear in. See SuzerainStoryPackInfo.

assignedTokenName string

The name of the token this report should appear on. See SuzerainTokenName.

title string

The title of this report.

description string

The description of this report.

Exceptions

ArgumentNullException

Thrown if any required arguments are null.

Properties

AssignedTokenName

The name of the token this report should appear on. See SuzerainTokenName.

public string AssignedTokenName { get; }

Property Value

string

See Also

SuzerainTokenName

Description

The description of this report.

public string Description { get; }

Property Value

string

Name

The unique identifier of this report.

public string Name { get; }

Property Value

string

StoryPack

The story pack that this report should appear in. See SuzerainStoryPackInfo.

public StoryPackInfo StoryPack { get; }

Property Value

StoryPackInfo

See Also

SuzerainStoryPackInfo

Title

The title of this report.

public string Title { get; }

Property Value

string

See Also

AddCustomReport(CustomReportData)