• 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 Item

    Base clase of all items in the game. This is an abstract class and need to be inherited to specify behaviour. The project offer 3 type of items : UsableItem, Equipment and Weapon

    Inheritance
    System.Object
    UnityEngine.Object
    UnityEngine.ScriptableObject
    Item
    EquipmentItem
    UsableItem
    Namespace: CreatorKitCode
    Assembly: Assembly-CSharp.dll
    Syntax
    public abstract class Item : ScriptableObject

    Fields

    Description

    Declaration
    public string Description
    Field Value
    Type Description
    System.String

    ItemName

    Declaration
    public string ItemName
    Field Value
    Type Description
    System.String

    ItemSprite

    Declaration
    public Sprite ItemSprite
    Field Value
    Type Description
    UnityEngine.Sprite

    WorldObjectPrefab

    Declaration
    public GameObject WorldObjectPrefab
    Field Value
    Type Description
    UnityEngine.GameObject

    Methods

    GetDescription()

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

    UsedBy(CharacterData)

    Called by the inventory system when the object is "used" (double clicked)

    Declaration
    public virtual bool UsedBy(CharacterData user)
    Parameters
    Type Name Description
    CharacterData user

    The CharacterDate that used that item

    Returns
    Type Description
    System.Boolean

    If it was actually used (allow the inventory to know if it can remove the object or not)

    Back to top Generated by DocFX