Class CharacterBase<TCharacterType, TCharacterHandler>

Namespace

BlazerTech.CharacterManagement.Characters

Assembly

Assembly-CSharp.dll

public abstract class CharacterBase<TCharacterType, TCharacterHandler> : IValidatable where TCharacterType : CharacterTypeBaseSO where TCharacterHandler : LoadedCharacterHandlerBase

Type Parameters

TCharacterType

TCharacterHandler

Inheritance

object

CharacterBase<TCharacterType, TCharacterHandler>

Implements

IValidatable

Derived

LayeredCharacter

UnifiedCharacter

Constructors

CharacterBase(string, TCharacterType, string)

public CharacterBase(string characterName, TCharacterType characterType, string displayName = "")

Parameters

characterName string

characterType TCharacterType

displayName string

Fields

CharacterGUID

A unique identifier used to reference the character.

public readonly Guid CharacterGUID

Field Value

Guid

Remarks

Automatically generated in constructor.

CharacterName

Name used to reference the character.

public readonly string CharacterName

Field Value

string

CharacterType

public readonly TCharacterType CharacterType

Field Value

TCharacterType

LoadedCharacterHandler

public TCharacterHandler LoadedCharacterHandler

Field Value

TCharacterHandler

Properties

CharacterDisplayName

A display name which can be used to show a characters name in-game.

public string CharacterDisplayName { get; set; }

Property Value

string

IsValid

True if the character was initiialized correctly; otherwise, false.

public bool IsValid { get; protected set; }

Property Value

bool

Methods

AcquireCharacterHandler(object)

public TCharacterHandler AcquireCharacterHandler(object owner)

Parameters

owner object

Returns

TCharacterHandler

AcquireCharacterHandlerAsync(object)

public Task<TCharacterHandler> AcquireCharacterHandlerAsync(object owner)

Parameters

owner object

Returns

Task<TCharacterHandler>

LoadCharacterHandler()

protected abstract void LoadCharacterHandler()

LoadCharacterHandlerAsync()

protected abstract Task LoadCharacterHandlerAsync()

Returns

Task

PerformValidationCheck()

Determines whether the current character instance is valid by verifying that the CharacterName is not blank and the CharacterType is assigned and valid.

public virtual bool PerformValidationCheck()

Returns

bool

true if the character passes all validation checks; otherwise, false.

See Also

CharacterType

ReleaseCharacterHandler(object)

public void ReleaseCharacterHandler(object owner)

Parameters

owner object

SetCharacterInvalid()

public void SetCharacterInvalid()

UnloadCharacterHandler()

protected virtual void UnloadCharacterHandler()