Class SlugBaseCharacter

A character added by SlugBase.

Inheritance

object

SlugBaseCharacter

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SlugBase

Assembly: SlugBase.dll

Syntax

public class SlugBaseCharacter

Properties

Description

A description of this character that appears on the select menu.

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

DisplayName

The displayed name of this character, such as "The Survivor", "The Monk", or "The Hunter".

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
string

Features

Settings, abilities, or other Features of this character.

Declaration

public SlugBaseCharacter.FeatureList Features { get; }

Property Value

Type	Description
SlugBaseCharacter.FeatureList

Name

This character's unique name.

Declaration

public SlugcatStats.Name Name { get; }

Property Value

Type	Description
Name

Registry

Stores all registered SlugBaseCharacters.

Declaration

public static JsonRegistry<SlugcatStats.Name, SlugBaseCharacter> Registry { get; }

Property Value

Type	Description
JsonRegistry<SlugcatStats.Name, SlugBaseCharacter>

Methods

Create(string)

Creates a new, blank SlugBaseCharacter.

Declaration

public static SlugBaseCharacter Create(string id)

Parameters

Type	Name	Description
string	id	The new character's unique ID.

Returns

Type	Description
SlugBaseCharacter	A new SlugBaseCharacter with a default name, default description, and no features.

Remarks

Use DisplayName, Description, and Features to customize this character.

Get(Name)

Gets a SlugBaseCharacter by name.

Declaration

public static SlugBaseCharacter Get(SlugcatStats.Name name)

Parameters

Type	Name	Description
Name	name	The SlugcatStats.Name to search for.

Returns

Type	Description
SlugBaseCharacter	The SlugBaseCharacter, or null if it was not found.

TryGet(Name, out SlugBaseCharacter)

Gets a SlugBaseCharacter by name.

Declaration

public static bool TryGet(SlugcatStats.Name name, out SlugBaseCharacter character)

Parameters

Type	Name	Description
Name	name	The SlugcatStats.Name to search for.
SlugBaseCharacter	character	The SlugBaseCharacter with the given name, or null if it was not found.

Returns

Type	Description
bool	true if the SlugBaseCharacter was found, false otherwise.

Events

Refreshed

Occurs when any SlugBaseCharacter's JSON file is modified, after all features have been loaded.

Declaration

public static event EventHandler<SlugBaseCharacter.RefreshEventArgs> Refreshed

Event Type

Type	Description
EventHandler<SlugBaseCharacter.RefreshEventArgs>

Remarks

This event is only raised when in-game.