Class RacialOverrideEffect

Allows an effect to override player's racial display information such as race name and portrait. Used for vampirism and lycanthropy and possibly could be used for future racial overrides. Considered a minimal implementation at this time for core game to support vamp/were only. Only intended to be used on player entity. Will be permanent until removed. Only a single racial override incumbent effect can be active on player at one time.

Inheritance
Object
BaseEntityEffect
IncumbentEffect
RacialOverrideEffect
LycanthropyEffect
VampirismEffect
Inherited Members
Namespace: DaggerfallWorkshop.Game.MagicAndEffects.MagicEffects
Assembly: Assembly-CSharp.dll
Syntax
public abstract class RacialOverrideEffect : IncumbentEffect, IEntityEffect, IMacroContextProvider

Fields

| Improve this Doc View Source

forcedRoundsRemaining

Declaration
protected int forcedRoundsRemaining
Field Value
Type Description
Int32

Properties

| Improve this Doc View Source

CustomRace

Gets custom race exposed by this override

Declaration
public abstract RaceTemplate CustomRace { get; }
Property Value
Type Description
RaceTemplate
| Improve this Doc View Source

RoundsRemaining

Declaration
public override int RoundsRemaining { get; }
Property Value
Type Description
Int32
Overrides
| Improve this Doc View Source

SuppressCrime

Allows racial override to suppress crimes by player.

Declaration
public virtual bool SuppressCrime { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

SuppressOptionalCombatVoices

Allow racial override to suppress Combat Voices option as required.

Declaration
public virtual bool SuppressOptionalCombatVoices { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

SuppressPaperDollBodyAndItems

Allow racial override to suppress paper doll body and items to show background only.

Declaration
public virtual bool SuppressPaperDollBodyAndItems { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

SuppressPopulationSpawns

Allows racial override to suppress population spawns.

Declaration
public virtual bool SuppressPopulationSpawns { get; }
Property Value
Type Description
Boolean

Methods

| Improve this Doc View Source

AddState(IncumbentEffect)

Declaration
protected override void AddState(IncumbentEffect incumbent)
Parameters
Type Name Description
IncumbentEffect incumbent
Overrides
| Improve this Doc View Source

CheckFastTravel(PlayerEntity)

Checks if custom race can initiate fast travel. Return true to allow fast travel or false to block it.

Declaration
public virtual bool CheckFastTravel(PlayerEntity playerEntity)
Parameters
Type Name Description
PlayerEntity playerEntity
Returns
Type Description
Boolean
| Improve this Doc View Source

CheckStartRest(PlayerEntity)

Checks if custom race can initiate rest. Return true to allow rest or false to block it.

Declaration
public virtual bool CheckStartRest(PlayerEntity playerEntity)
Parameters
Type Name Description
PlayerEntity playerEntity
Returns
Type Description
Boolean
| Improve this Doc View Source

GetCustomHeadImageData(PlayerEntity, out ImageData)

Gets custom head ImageData for this override. Return false to just use standard head.

Declaration
public virtual bool GetCustomHeadImageData(PlayerEntity playerEntity, out ImageData imageDataOut)
Parameters
Type Name Description
PlayerEntity playerEntity
ImageData imageDataOut
Returns
Type Description
Boolean
| Improve this Doc View Source

GetCustomPaperDollBackgroundTexture(PlayerEntity, out Texture2D)

Gets custom paper doll background texture for this override. Return false to use standard background for race.

Declaration
public virtual bool GetCustomPaperDollBackgroundTexture(PlayerEntity playerEntity, out Texture2D textureOut)
Parameters
Type Name Description
PlayerEntity playerEntity
Texture2D textureOut
Returns
Type Description
Boolean
| Improve this Doc View Source

GetCustomRaceGenderAttackSoundData(PlayerEntity, out SoundClips)

Gets custom attack sound clip for race and gender.

Declaration
public virtual bool GetCustomRaceGenderAttackSoundData(PlayerEntity playerEntity, out SoundClips soundClipOut)
Parameters
Type Name Description
PlayerEntity playerEntity
SoundClips soundClipOut
Returns
Type Description
Boolean
| Improve this Doc View Source

GetSuppressInventory(out String)

Allow racial override to suppress inventory UI. Some care might need to be taken by other systems this does not crash game like classic.

Declaration
public virtual bool GetSuppressInventory(out string suppressInventoryMessage)
Parameters
Type Name Description
String suppressInventoryMessage

Optional message to display when inventory suppressed.
Returns
Type Description
Boolean

True if inventory should be suppressed.
| Improve this Doc View Source

GetSuppressTalk(out String)

Allow racial overrides to suppress talk UI.

Declaration
public virtual bool GetSuppressTalk(out string suppressTalkMessage)
Parameters
Type Name Description
String suppressTalkMessage

Optional message to display when talk suppressed.
Returns
Type Description
Boolean

True if talk should be suppressed.
| Improve this Doc View Source

IsLikeKind(IncumbentEffect)

Declaration
protected override bool IsLikeKind(IncumbentEffect other)
Parameters
Type Name Description
IncumbentEffect other
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

OnWeaponHitEntity(PlayerEntity, DaggerfallEntity)

Called by WeaponManager when player hits an entity with a weapon (includes hand-to-hand). Target entity may be null, racial overrides should handle this.

Declaration
public virtual void OnWeaponHitEntity(PlayerEntity playerEntity, DaggerfallEntity targetEntity = null)
Parameters
Type Name Description
PlayerEntity playerEntity
DaggerfallEntity targetEntity
| Improve this Doc View Source

RemoveRound()

Declaration
protected override int RemoveRound()
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

SetFPSWeapon(FPSWeapon)

Set state of current FPS weapon from WeaponManager. Allows the racial override to set a unique weapon type such as wereclaws.

Declaration
public virtual bool SetFPSWeapon(FPSWeapon target)
Parameters
Type Name Description
FPSWeapon target

Target FPSWeapon to change.
Returns
Type Description
Boolean

True if weapon changed.
| Improve this Doc View Source

StartQuest(Boolean)

Starts custom racial quest.

  • Called every 38 days with isCureQuest = false
  • Called every 84 days with isCureQuest = true Mainly used by vampirism and lycanthropy in core. Custom racial override effects can ignore this virtual to start and manage quests however they like.
Declaration
public virtual void StartQuest(bool isCureQuest)
Parameters
Type Name Description
Boolean isCureQuest

True when this should start cure quest.

Implements