Class CustomConversationFragment

Namespace

SuzerainModdingKit.StoryFragments.Conversation

Assembly

SuzerainModdingKit.dll

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

public class CustomConversationFragment : CustomStoryFragmentData

Inheritance

object

CustomStoryFragmentData

CustomConversationFragment

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

CustomConversationFragment(string, StoryPackInfo, string, string, string, ConversationType, string)

Creates a new instance of this class.

public CustomConversationFragment(string name, StoryPackInfo storyPack, string assignedTokenName, string hubTitle, string hubDescription, ConversationData.ConversationType type, string conversationName)

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.

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.

type ConversationData.ConversationType

The conversation type.

conversationName string

The name of the conversation that this story fragment opens.

Exceptions

ArgumentNullException

Thrown if any required arguments are null.

Properties

ConversationName

The name of the conversation that this story fragment opens.

public string ConversationName { 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

Type

The conversation type.

public ConversationData.ConversationType Type { get; }

Property Value

ConversationData.ConversationType

See Also

AddCustomStoryFragment(CustomStoryFragmentData, AddStoryFragmentOptions)