Search Results for

    Show / Hide Table of Contents

    Class TriggerConfig

    Represents a configuration of AbilityTrigger. A trigger can have multiple configurations to give the ability "button" multiple functions depending on context.

    Only manaCost, maxCharges, cooldownTime and minimumDelay are safely editable during runtime on server.

    Inheritance
    object
    TriggerConfig
    Namespace: Global
    Assembly: Dew.Core.dll
    Syntax
    [Serializable]
    public class TriggerConfig

    Fields

    alwaysCastImmediately

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [HideIf("@!isActive", true)]
    public bool alwaysCastImmediately
    Field Value
    Type Description
    bool

    appliedStatusEffectRef

    Declaration
    [HideIf("isActive", true)]
    public StatusEffect appliedStatusEffectRef
    Field Value
    Type Description
    StatusEffect

    canConsumeCastBonus

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [HideIf("@!isActive", true)]
    public bool canConsumeCastBonus
    Field Value
    Type Description
    bool

    canReceiveCooldownReduction

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [LabelText("Can Receive Cooldown Reduction")]
    public bool canReceiveCooldownReduction
    Field Value
    Type Description
    bool

    castByMoveDirectionByDefault

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [HideIf("@!isActive", true)]
    public bool castByMoveDirectionByDefault
    Field Value
    Type Description
    bool

    castByMoveDirectionGamepad

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [HideIf("@!isActive", true)]
    public bool castByMoveDirectionGamepad
    Field Value
    Type Description
    bool

    castMethod

    You must call AbilityTrigger.SyncCastMethodChanges after modifying this on server.

    Declaration
    [ShowIf("isActive", true)]
    [HideLabel]
    [BoxGroup("B", false, false, 0)]
    public CastMethodData castMethod
    Field Value
    Type Description
    CastMethodData

    castVoice

    Declaration
    [ShowIf("isActive", true)]
    public DewAudioClip castVoice
    Field Value
    Type Description
    DewAudioClip

    channel

    Declaration
    [HideLabel]
    [ShowIf("isActive", true)]
    public TriggerChannelData channel
    Field Value
    Type Description
    TriggerChannelData

    destroyExistingEffect

    Declaration
    [ShowIf("@(spawnedInstance is StatusEffect)", true)]
    public bool destroyExistingEffect
    Field Value
    Type Description
    bool

    effectOnCast

    Declaration
    [ShowIf("isActive", true)]
    [LabelText("Channel Effect")]
    public GameObject effectOnCast
    Field Value
    Type Description
    UnityEngine.GameObject

    endAnim

    Declaration
    [ShowIf("isActive", true)]
    public DewAnimationClip endAnim
    Field Value
    Type Description
    DewAnimationClip

    faceForward

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [LabelText("Face Forward When Cast")]
    [HideIf("@castMethod.type == CastMethodType.None || !isActive", true)]
    public bool faceForward
    Field Value
    Type Description
    bool

    ignoreAbilityLock

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [HideIf("@!isActive", true)]
    public bool ignoreAbilityLock
    Field Value
    Type Description
    bool

    ignoreAimDirectionGamepad

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [HideIf("@!isActive", true)]
    public bool ignoreAimDirectionGamepad
    Field Value
    Type Description
    bool

    ignoreBlock

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [LabelText("Ignore Channel Block")]
    [HideIf("@!isActive", true)]
    public bool ignoreBlock
    Field Value
    Type Description
    bool

    isActive

    Declaration
    [VerticalGroup("HorizontalC/VerticalA", 0)]
    public bool isActive
    Field Value
    Type Description
    bool

    lockCastUntilKilled

    Declaration
    [ToggleLeft]
    public bool lockCastUntilKilled
    Field Value
    Type Description
    bool

    lockCooldownUntilKilled

    Declaration
    [ToggleLeft]
    public bool lockCooldownUntilKilled
    Field Value
    Type Description
    bool

    moveTowardsCastDirection

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [ShowIf("isActive", true)]
    public bool moveTowardsCastDirection
    Field Value
    Type Description
    bool

    overrideRotation

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [ShowIf("@isActive && faceForward", true)]
    public bool overrideRotation
    Field Value
    Type Description
    bool

    overrideRotationDuration

    Declaration
    [BoxGroup("A", false, false, 0)]
    [LabelText("Duration")]
    [ShowIf("@overrideRotation && isActive", true)]
    public float overrideRotationDuration
    Field Value
    Type Description
    float

    postDelay

    Declaration
    [ShowIf("isActive", true)]
    public float postDelay
    Field Value
    Type Description
    float

    postponeBasicCommand

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [LabelText("Continue Basic Command Afterwards")]
    [ShowIf("isActive", true)]
    public bool postponeBasicCommand
    Field Value
    Type Description
    bool

    predictionSettings

    Declaration
    [ShowIf("isActive", true)]
    public AbilityTrigger.PredictionSettings predictionSettings
    Field Value
    Type Description
    AbilityTrigger.PredictionSettings

    selfValidator

    Declaration
    [HideLabel]
    [BoxGroup("A", false, false, 0)]
    [ShowIf("isActive", true)]
    public AbilitySelfValidator selfValidator
    Field Value
    Type Description
    AbilitySelfValidator

    setFillAmount

    Declaration
    [ShowIf("IsStatusEffectNonTargeted", true)]
    public bool setFillAmount
    Field Value
    Type Description
    bool

    spawnedInstanceRef

    Declaration
    [InfoBox("StatusEffect will be applied to the caster.", "IsStatusEffectNonTargeted")]
    [ShowIf("isActive", true)]
    public AssetRef<AbilityInstance> spawnedInstanceRef
    Field Value
    Type Description
    AssetRef<AbilityInstance>

    startAnim

    Declaration
    [FormerlySerializedAs("animation")]
    [ShowIf("isActive", true)]
    public DewAnimationClip startAnim
    Field Value
    Type Description
    DewAnimationClip

    startCharges

    Declaration
    [HorizontalGroup("HorizontalB", 0, 0, 0, 0)]
    [LabelText("Start")]
    [LabelWidth(55)]
    [SerializeField]
    [JsonProperty]
    public int startCharges
    Field Value
    Type Description
    int

    targetValidator

    Declaration
    [ShowIf("isActive", true)]
    [HideLabel]
    public AbilityTargetValidator targetValidator
    Field Value
    Type Description
    AbilityTargetValidator

    triggerIcon

    Declaration
    [PreviewField(ObjectFieldAlignment.Left, Height = 40)]
    [HideLabel]
    [HorizontalGroup("HorizontalC", 40, 0, 0, 0)]
    public Sprite triggerIcon
    Field Value
    Type Description
    UnityEngine.Sprite

    unstoppableWhileCasting

    Declaration
    [BoxGroup("A", false, false, 0)]
    [ToggleLeft]
    [HideIf("@!isActive", true)]
    public bool unstoppableWhileCasting
    Field Value
    Type Description
    bool

    victim

    Declaration
    [ShowIf("@(spawnedInstance is StatusEffect) && (castMethod.type == CastMethodType.Target)", true)]
    public TriggerConfig.StatusEffectVictimType victim
    Field Value
    Type Description
    TriggerConfig.StatusEffectVictimType

    Properties

    addedCharges

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

    appliedStatusEffect

    Declaration
    public StatusEffect appliedStatusEffect { get; set; }
    Property Value
    Type Description
    StatusEffect

    cooldownTime

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

    effectiveRange

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

    manaCost

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

    maxCharges

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

    minimumDelay

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

    spawnedInstance

    Declaration
    public AbilityInstance spawnedInstance { get; set; }
    Property Value
    Type Description
    AbilityInstance

    Methods

    CheckRange(CastInfo)

    Returns true if provided info can be casted immediately.
    Returns false if provided info needs further movement to get in range.
    You may call this regardless of cast method type,
    But note that CastMethodType.Point will always return true if isClamping is true.

    Declaration
    public bool CheckRange(CastInfo info)
    Parameters
    Type Name Description
    CastInfo info
    Returns
    Type Description
    bool
    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    CheckRange(Entity, Entity)

    Declaration
    public bool CheckRange(Entity caster, Entity target)
    Parameters
    Type Name Description
    Entity caster
    Entity target
    Returns
    Type Description
    bool

    GetMoveToCastDestination(CastInfo)

    Get move-to-cast destination.

    Declaration
    public Vector3 GetMoveToCastDestination(CastInfo info)
    Parameters
    Type Name Description
    CastInfo info
    Returns
    Type Description
    UnityEngine.Vector3
    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    GetMoveToCastRequiredDistance(CastInfo)

    Get move-to-cast required distance on XZ plane (agent position).

    Declaration
    public float GetMoveToCastRequiredDistance(CastInfo info)
    Parameters
    Type Name Description
    CastInfo info
    Returns
    Type Description
    float
    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    IsStatusEffectNonTargeted()

    Declaration
    public bool IsStatusEffectNonTargeted()
    Returns
    Type Description
    bool
    In This Article
    Back to top Shape of Dreams API Documentation