• Api Documentation

    Show / Hide Table of Contents
    • CreatorKitCode
      • BaseElementalEffect
      • CharacterData
      • Container
      • ElementalEffect
      • EquipmentItem
      • EquipmentItem.EquipmentSlot
      • EquipmentItem.EquippedEffect
      • EquipmentSystem
      • Helpers
      • HighlightableObject
      • InteractableObject
      • InventorySystem
      • InventorySystem.InventoryEntry
      • Item
      • Loot
      • LootSpawner
      • LootSpawner.LootEntry
      • LootSpawner.SpawnEvent
      • SFXManager
      • SFXManager.PlayData
      • SFXManager.Use
      • SpawnPoint
      • StatSystem
      • StatSystem.DamageType
      • StatSystem.StatModifier
      • StatSystem.StatModifier.Mode
      • StatSystem.Stats
      • StatSystem.TimedStatModifier
      • UsableItem
      • UsableItem.UsageEffect
      • VFXDatabase
      • VFXDatabase.VFXDBEntry
      • VFXManager
      • VFXManager.VFXInstance
      • Weapon
      • Weapon.AttackData
      • Weapon.Stat
      • Weapon.WeaponAttackEffect
    • CreatorKitCodeInternal
      • AmbiencePlayer
      • AnimationControllerDispatcher
      • AnimationControllerDispatcher.IAttackFrameReceiver
      • AnimationControllerDispatcher.IFootstepFrameReceiver
      • AttackState
      • BreakableObject
      • CameraController
      • CharacterAudio
      • CharacterControl
      • DamageUI
      • DamageUI.ActiveText
      • EffectIconUI
      • EquipmentUI
      • InventoryCharacterRender
      • InventoryUI
      • InventoryUI.DragData
      • ItemEntryUI
      • ItemTooltip
      • LootUI
      • RandomBGMPlayer
      • RandomLoopOffset
      • ResourceManager
      • SceneLinkedSMB<TMonoBehaviour>
      • SimpleEnemyController
      • SimpleEnemyController.State
      • TrainingDummy
      • UIAlphaRaycast
      • UISystem

    Class Weapon.WeaponAttackEffect

    Base class of all effect you can add on a weapon to specialize it. See documentation on How to write a new Weapon Effect.

    Inheritance
    System.Object
    UnityEngine.Object
    UnityEngine.ScriptableObject
    Weapon.WeaponAttackEffect
    Namespace: CreatorKitCode
    Assembly: Assembly-CSharp.dll
    Syntax
    public abstract class WeaponAttackEffect : ScriptableObject

    Fields

    Description

    Declaration
    public string Description
    Field Value
    Type Description
    System.String

    Methods

    GetDescription()

    Declaration
    public virtual string GetDescription()
    Returns
    Type Description
    System.String

    OnAttack(CharacterData, CharacterData, ref Weapon.AttackData)

    Declaration
    public virtual void OnAttack(CharacterData target, CharacterData user, ref Weapon.AttackData data)
    Parameters
    Type Name Description
    CharacterData target
    CharacterData user
    Weapon.AttackData data

    OnPostAttack(CharacterData, CharacterData, Weapon.AttackData)

    Declaration
    public virtual void OnPostAttack(CharacterData target, CharacterData user, Weapon.AttackData data)
    Parameters
    Type Name Description
    CharacterData target
    CharacterData user
    Weapon.AttackData data
    Back to top Generated by DocFX