Class Gem

Essence. It can be equipped to gem slots to provide special effects on skills and heroes.

Inheritance
object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
Mirror.NetworkBehaviour
DewNetworkBehaviour
Actor
Gem
Implements
Inherited Members
Namespace: Global
Assembly: Dew.Core.dll
Syntax
public class Gem : Actor, ILogicUpdate, ICleanup, ICustomDestroyRoutine, IInteractable, IItem, IExcludeFromPool

Fields

ClientEvent_OnHandOwnerChanged

Declaration
public SafeAction<Hero, Hero> ClientEvent_OnHandOwnerChanged
Field Value
Type Description
SafeAction<Hero, Hero>

ClientEvent_OnOwnerChanged

Declaration
public SafeAction<Hero, Hero> ClientEvent_OnOwnerChanged
Field Value
Type Description
SafeAction<Hero, Hero>

ClientEvent_OnTempOwnerChanged

Declaration
public SafeAction<DewPlayer, DewPlayer> ClientEvent_OnTempOwnerChanged
Field Value
Type Description
SafeAction<DewPlayer, DewPlayer>

ClientGemEvent_OnCooldownReady

Declaration
public SafeAction ClientGemEvent_OnCooldownReady
Field Value
Type Description
SafeAction

ClientGemEvent_OnCooldownReduced

Declaration
public SafeAction<float> ClientGemEvent_OnCooldownReduced
Field Value
Type Description
SafeAction<float>

ClientGemEvent_OnCooldownReducedByRatio

Declaration
public SafeAction<float> ClientGemEvent_OnCooldownReducedByRatio
Field Value
Type Description
SafeAction<float>

ClientGemEvent_OnCooldownStarted

Declaration
public SafeAction ClientGemEvent_OnCooldownStarted
Field Value
Type Description
SafeAction

ClientGemEvent_OnFlash

Declaration
public SafeAction ClientGemEvent_OnFlash
Field Value
Type Description
SafeAction

ClientGemEvent_OnQualityChanged

Declaration
public SafeAction<int, int> ClientGemEvent_OnQualityChanged
Field Value
Type Description
SafeAction<int, int>

cooldownTime

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
[ShowIf("isCooldownEnabled", true)]
public ScalingValue cooldownTime
Field Value
Type Description
ScalingValue

enableStatBonus

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
public bool enableStatBonus
Field Value
Type Description
bool

excludeFromPool

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
public bool excludeFromPool
Field Value
Type Description
bool

GemMergeExponent

Declaration
public const float GemMergeExponent = 1
Field Value
Type Description
float

icon

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
public Sprite icon
Field Value
Type Description
UnityEngine.Sprite

isCooldownEnabled

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
public bool isCooldownEnabled
Field Value
Type Description
bool

isRateLimited

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
public bool isRateLimited
Field Value
Type Description
bool

rarity

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
public Rarity rarity
Field Value
Type Description
Rarity

rateLimitCount

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
[ShowIf("isRateLimited", true)]
public ScalingValue rateLimitCount
Field Value
Type Description
ScalingValue

rateLimitTime

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
[ShowIf("isRateLimited", true)]
public ScalingValue rateLimitTime
Field Value
Type Description
ScalingValue

readyEffect

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
[ShowIf("isCooldownEnabled", true)]
public GameObject readyEffect
Field Value
Type Description
UnityEngine.GameObject

setNumberDisplay

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
[ShowIf("isRateLimited", true)]
public bool setNumberDisplay
Field Value
Type Description
bool

statBonus

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
[ShowIf("enableStatBonus", true)]
public StatBonus statBonus
Field Value
Type Description
StatBonus

tags

Declaration
[BoxGroup("Gem Settings", true, false, 0)]
public DescriptionTags tags
Field Value
Type Description
DescriptionTags

tvDefaultAllExceptSelf

Declaration
protected AbilityTargetValidatorWrapper tvDefaultAllExceptSelf
Field Value
Type Description
AbilityTargetValidatorWrapper

tvDefaultHarmfulEffectTargets

Declaration
protected AbilityTargetValidatorWrapper tvDefaultHarmfulEffectTargets
Field Value
Type Description
AbilityTargetValidatorWrapper

tvDefaultUsefulEffectTargets

Declaration
protected AbilityTargetValidatorWrapper tvDefaultUsefulEffectTargets
Field Value
Type Description
AbilityTargetValidatorWrapper

Properties

canInteractWithMouse

Declaration
public bool canInteractWithMouse { get; }
Property Value
Type Description
bool

currentCooldown

Declaration
public float currentCooldown { get; }
Property Value
Type Description
float

dismantleDreamDustOverride

Declaration
public int? dismantleDreamDustOverride { get; set; }
Property Value
Type Description
int?

dismantleProgress

Declaration
public float dismantleProgress { get; }
Property Value
Type Description
float

effectiveLevel

Declaration
public int effectiveLevel { get; }
Property Value
Type Description
int

fillAmount

Declaration
public float fillAmount { get; set; }
Property Value
Type Description
float

focusDistance

Declaration
public float focusDistance { get; }
Property Value
Type Description
float

handOwner

Declaration
public Hero handOwner { get; set; }
Property Value
Type Description
Hero

interactPivot

Declaration
public Transform interactPivot { get; }
Property Value
Type Description
UnityEngine.Transform

isDestroyedOnRoomChange

Declaration
public override bool isDestroyedOnRoomChange { get; }
Property Value
Type Description
bool
Overrides

isLocked

Is this gem locked for local player?

Declaration
public bool isLocked { get; }
Property Value
Type Description
bool

isNotReadyByRateLimit

Is this gem not ready because of rate limit?

Declaration
public bool isNotReadyByRateLimit { get; }
Property Value
Type Description
bool

isValid

Returns true if gem is not destroyed, is active, and has owner.

Declaration
public bool isValid { get; }
Property Value
Type Description
bool

location

Location of this gem if equipped to a hero.

Declaration
public GemLocation location { get; set; }
Property Value
Type Description
GemLocation

maxCooldown

Declaration
public float maxCooldown { get; }
Property Value
Type Description
float

maxSellGold

Declaration
public int maxSellGold { get; set; }
Property Value
Type Description
int

numberDisplay

Declaration
public int? numberDisplay { get; set; }
Property Value
Type Description
int?

owner

Declaration
public Hero owner { get; set; }
Property Value
Type Description
Hero

quality

Declaration
[SaveVar(SaveVarFlags.Default)]
public int quality { get; set; }
Property Value
Type Description
int

qualityType

Declaration
public Gem.QualityType qualityType { get; }
Property Value
Type Description
Gem.QualityType

sellGoldOverride

Declaration
public int? sellGoldOverride { get; set; }
Property Value
Type Description
int?

skill

Declaration
public SkillTrigger skill { get; set; }
Property Value
Type Description
SkillTrigger

skipStartAnimation

Declaration
public bool skipStartAnimation { get; set; }
Property Value
Type Description
bool

tempOwner

Declaration
public DewPlayer tempOwner { get; set; }
Property Value
Type Description
DewPlayer

worldModel

Declaration
public ItemWorldModel worldModel { get; }
Property Value
Type Description
ItemWorldModel

Methods

ApplyCooldownReduction(float)

Declaration
public void ApplyCooldownReduction(float amount)
Parameters
Type Name Description
float amount

ApplyCooldownReductionByRatio(float)

Declaration
public void ApplyCooldownReductionByRatio(float ratio)
Parameters
Type Name Description
float ratio

Awake()

Declaration
protected override void Awake()
Overrides

CanInteract(Entity)

Declaration
public bool CanInteract(Entity entity)
Parameters
Type Name Description
Entity entity
Returns
Type Description
bool

CreateAbilityInstanceWithSource<T>(Actor, Vector3, Quaternion?, CastInfo, Action<T>)

Create an ability instance on behalf of source actor, but make it inherit this gem's quality. You MUST ensure source will not be destroyed before calling this. Call this right after instance spawn or use Actor.LockDestroy().

Declaration
public T CreateAbilityInstanceWithSource<T>(Actor source, Vector3 position, Quaternion? rotation, CastInfo info, Action<T> beforePrepare = null) where T : AbilityInstance
Parameters
Type Name Description
Actor source
UnityEngine.Vector3 position
UnityEngine.Quaternion? rotation
CastInfo info
System.Action<T><T> beforePrepare
Returns
Type Description
T
Type Parameters
Name Description
T

CreateBasicEffectWithSource(Actor, Entity, BasicEffect, float, string, DuplicateEffectBehavior)

Create a basic effect container on behalf of source actor. You MUST ensure source will not be destroyed before calling this. Call this right after instance spawn or use Actor.LockDestroy().

Declaration
public Se_GenericEffectContainer CreateBasicEffectWithSource(Actor source, Entity victim, BasicEffect eff, float duration, string id, DuplicateEffectBehavior onDuplicate = DuplicateEffectBehavior.ReplacePrevious)
Parameters
Type Name Description
Actor source
Entity victim
BasicEffect eff
float duration
string id
DuplicateEffectBehavior onDuplicate
Returns
Type Description
Se_GenericEffectContainer

CreateStatusEffectWithSource<T>(Actor, Entity, CastInfo, Action<T>)

Create a status effect on behalf of source actor, but make it inherit this gem's quality. You MUST ensure source will not be destroyed before calling this. Call this right after instance spawn or use Actor.LockDestroy().

Declaration
public T CreateStatusEffectWithSource<T>(Actor source, Entity victim, CastInfo info, Action<T> beforePrepare = null) where T : StatusEffect
Parameters
Type Name Description
Actor source
Entity victim
CastInfo info
System.Action<T><T> beforePrepare
Returns
Type Description
T
Type Parameters
Name Description
T

DismantleGem()

Declaration
public void DismantleGem()

GetBuyGold()

Declaration
public int GetBuyGold()
Returns
Type Description
int

GetBuyGold(Rarity, int)

Declaration
public static int GetBuyGold(Rarity rarity, int quality)
Parameters
Type Name Description
Rarity rarity
int quality
Returns
Type Description
int

GetDismantleAmount(DewPlayer)

Declaration
public int GetDismantleAmount(DewPlayer player)
Parameters
Type Name Description
DewPlayer player
Returns
Type Description
int

GetGoldValue(Rarity, int)

Declaration
public static int GetGoldValue(Rarity rarity, int quality)
Parameters
Type Name Description
Rarity rarity
int quality
Returns
Type Description
int

GetMergedQuality(int, int)

Declaration
public static int GetMergedQuality(int a, int b)
Parameters
Type Name Description
int a
int b
Returns
Type Description
int

GetQualityType(float)

Declaration
public static Gem.QualityType GetQualityType(float quality)
Parameters
Type Name Description
float quality
Returns
Type Description
Gem.QualityType

GetSellGold()

Declaration
public int GetSellGold()
Returns
Type Description
int

GetSellGold(Rarity, int)

Declaration
public static int GetSellGold(Rarity rarity, int quality)
Parameters
Type Name Description
Rarity rarity
int quality
Returns
Type Description
int

GetValue(ScalingValue)

Gets value of the given scaling value using this gem's level and caster.

Declaration
public float GetValue(ScalingValue val)
Parameters
Type Name Description
ScalingValue val
Returns
Type Description
float

IsLockedFor(DewPlayer)

Declaration
public bool IsLockedFor(DewPlayer player)
Parameters
Type Name Description
DewPlayer player
Returns
Type Description
bool

IsReady()

Is this gem ready? By default this checks if the gem is cooled down and has at least 1 use left (rate-limit).

This must return the same value everywhere(server/clients) for consistent behavior.

Declaration
public virtual bool IsReady()
Returns
Type Description
bool

LogicUpdate(float)

Declaration
public override void LogicUpdate(float dt)
Parameters
Type Name Description
float dt
Overrides

NotifyUse()

Flash this gem in UI for highlighting or giving attention to player.
If this gem is rate-limited, it will decrement remaining use.

Declaration
public void NotifyUse()

OnCastComplete(EventInfoCast)

Called on server when equipped skill completes casting.

Declaration
protected virtual void OnCastComplete(EventInfoCast info)
Parameters
Type Name Description
EventInfoCast info

OnCastCompleteBeforePrepare(EventInfoCast)

Called on server when equipped skill creates ability instance before it is spawned and prepared.

Declaration
protected virtual void OnCastCompleteBeforePrepare(EventInfoCast info)
Parameters
Type Name Description
EventInfoCast info

OnDealDamage(EventInfoDamage)

Called on server when equipped skill deals damage.

Declaration
protected virtual void OnDealDamage(EventInfoDamage info)
Parameters
Type Name Description
EventInfoDamage info

OnDoHeal(EventInfoHeal)

Called on server when equipped skill does heal.

Declaration
protected virtual void OnDoHeal(EventInfoHeal obj)
Parameters
Type Name Description
EventInfoHeal obj

OnEquipGem(Hero)

Called everywhere when this gem is picked up by hero.

Declaration
public virtual void OnEquipGem(Hero newOwner)
Parameters
Type Name Description
Hero newOwner

OnEquipSkill(SkillTrigger)

Called everywhere when this gem starts taking effect on skill.

Declaration
public virtual void OnEquipSkill(SkillTrigger newSkill)
Parameters
Type Name Description
SkillTrigger newSkill

OnPrepare()

Declaration
protected override void OnPrepare()
Overrides

OnQualityChange(int, int)

Called everywhere when this gem's quality is changed.

Declaration
protected virtual void OnQualityChange(int oldQuality, int newQuality)
Parameters
Type Name Description
int oldQuality
int newQuality

OnStartClient()

Declaration
public override void OnStartClient()
Overrides

OnStartServer()

Declaration
public override void OnStartServer()
Overrides

OnUnequipGem(Hero)

Called everywhere when this gem is dropped by hero.

Declaration
public virtual void OnUnequipGem(Hero oldOwner)
Parameters
Type Name Description
Hero oldOwner

OnUnequipSkill(SkillTrigger)

Called everywhere when this gem stops taking effect on skill.

Declaration
public virtual void OnUnequipSkill(SkillTrigger oldSkill)
Parameters
Type Name Description
SkillTrigger oldSkill

ResetCooldown()

Declaration
public void ResetCooldown()

ShouldBeSavedWithRoom()

Declaration
public override bool ShouldBeSavedWithRoom()
Returns
Type Description
bool
Overrides

StartCooldown()

Declaration
public void StartCooldown()

Explicit Interface Implementations

IExcludeFromPool.excludeFromPool

Declaration
bool IExcludeFromPool.excludeFromPool { get; }
Returns
Type Description
bool

IInteractable.OnInteract(Entity, bool)

Declaration
void IInteractable.OnInteract(Entity entity, bool alt)
Parameters
Type Name Description
Entity entity
bool alt

IInteractable.priority

Declaration
int IInteractable.priority { get; }
Returns
Type Description
int

IItem.owner

Declaration
Entity IItem.owner { get; set; }
Returns
Type Description
Entity

IItem.rarity

Declaration
Rarity IItem.rarity { get; }
Returns
Type Description
Rarity

Implements

Extension Methods