• 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

    Special case of EquipmentItem for weapon, as they have a whole attack system in addition. Like Equipment they can have minimum stats and equipped effect, but also have a list of WeaponAttackEffect that will have their OnAttack function called during a hit, and their OnPostAttack function called after all OnAttack of all effects are called.

    Inheritance
    System.Object
    UnityEngine.Object
    UnityEngine.ScriptableObject
    Item
    EquipmentItem
    Weapon
    Inherited Members
    EquipmentItem.Slot
    EquipmentItem.MinimumStrength
    EquipmentItem.MinimumAgility
    EquipmentItem.MinimumDefense
    EquipmentItem.EquippedEffects
    EquipmentItem.UsedBy(CharacterData)
    EquipmentItem.EquippedBy(CharacterData)
    EquipmentItem.UnequippedBy(CharacterData)
    Item.ItemName
    Item.ItemSprite
    Item.Description
    Item.WorldObjectPrefab
    Namespace: CreatorKitCode
    Assembly: Assembly-CSharp.dll
    Syntax
    public class Weapon : EquipmentItem

    Fields

    AttackEffects

    Declaration
    public List<Weapon.WeaponAttackEffect> AttackEffects
    Field Value
    Type Description
    System.Collections.Generic.List<Weapon.WeaponAttackEffect>

    HitSounds

    Declaration
    [Header("Sounds")]
    public AudioClip[] HitSounds
    Field Value
    Type Description
    UnityEngine.AudioClip[]

    Stats

    Declaration
    [Header("Stats")]
    public Weapon.Stat Stats
    Field Value
    Type Description
    Weapon.Stat

    SwingSounds

    Declaration
    public AudioClip[] SwingSounds
    Field Value
    Type Description
    UnityEngine.AudioClip[]

    Methods

    Attack(CharacterData, CharacterData)

    Declaration
    public void Attack(CharacterData attacker, CharacterData target)
    Parameters
    Type Name Description
    CharacterData attacker
    CharacterData target

    CanHit(CharacterData, CharacterData)

    Declaration
    public bool CanHit(CharacterData attacker, CharacterData target)
    Parameters
    Type Name Description
    CharacterData attacker
    CharacterData target
    Returns
    Type Description
    System.Boolean

    GetDescription()

    Declaration
    public override string GetDescription()
    Returns
    Type Description
    System.String
    Overrides
    EquipmentItem.GetDescription()

    GetHitSound()

    Declaration
    public AudioClip GetHitSound()
    Returns
    Type Description
    UnityEngine.AudioClip

    GetSwingSound()

    Declaration
    public AudioClip GetSwingSound()
    Returns
    Type Description
    UnityEngine.AudioClip
    Back to top Generated by DocFX