Class CustomBillData

Namespace

SuzerainModdingKit.StoryFragments.Bill

Assembly

SuzerainModdingKit.dll

Represents the data required to define a custom bill story fragment for injection into the game.

public class CustomBillData : CustomStoryFragmentData

Inheritance

object

CustomStoryFragmentData

CustomBillData

Inherited Members

CustomStoryFragmentData.Name

CustomStoryFragmentData.StoryPack

CustomStoryFragmentData.AssignedTokenName

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CustomBillData(string, StoryPackInfo, string, string, string, string, string)

Creates a new instance of this class.

public CustomBillData(string name, StoryPackInfo storyPack, string assignedTokenName, string title, string description, string hubTitle, string hubDescription)

Parameters

name string

The unique identifier of this story fragment.

storyPack StoryPackInfo

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

assignedTokenName string

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

title string

The full title of this bill shown in the bill panel.

description string

The full description of this bill shown in the bill panel.

hubTitle string

The short title of this bill shown under the assigned token.

hubDescription string

The short description of this bill shown under the assigned token.

Exceptions

ArgumentNullException

Thrown if any required arguments are null.

Properties

Description

The full description of this bill shown in the bill panel.

public string Description { get; }

Property Value

string

HubDescription

The short description of this bill shown under the assigned token.

public string HubDescription { get; }

Property Value

string

HubTitle

The short title of this bill shown under the assigned token.

public string HubTitle { get; }

Property Value

string

Title

The full title of this bill shown in the bill panel.

public string Title { get; }

Property Value

string

See Also

AddCustomStoryFragment(CustomStoryFragmentData)