Documentation
  • AnyRPG Introduction
  • Getting Started
    • Installing AnyRPG
      • Unity Asset Store Installation
      • Github Installation
      • Unity Package Installation
    • Included sample games
    • Creating your first game
    • Configuring your game
    • Adding Content To Your Game
  • Wizards
    • Wizards Introduction
    • New Game Wizard
    • New Scene Wizard
    • New Equipment Set Wizard
    • Animation Profile Wizard
    • Screenshot Wizard
    • Template Content Wizard
    • New Character Wizard
    • New Weapon Wizard
    • Minimap Wizard
    • Rename Wizard
  • Scriptable Objects
    • Scriptable Objects Introduction
    • Abilities
      • Animated Ability
      • Channeled Ability
      • Craft Ability
      • Direct Ability
      • Gather Ability
    • Ability Effects
      • AOE Effect
      • Attack Effect
      • Capture Pet Effect
      • Channeled Effect
      • Direct Effect
      • Heal Effect
      • Instant Effect
      • Knock Back Effect
      • Mount Effect
      • Pet Control Effect
      • Pet Effect
      • Projectile Effect
      • Rain Effect
      • Remove Effect
      • Resurrect Effect
      • Status Effect
      • Summon Effect
      • Taunt Effect
      • Teleport Effect
    • Achievement
    • Animated Action
    • Animation Profile
    • Armor Class
    • Attachment Profile
    • Audio Profile
    • Behavior Profile
    • Character Class
    • Character Race
    • Character Stat
    • Chat Commands
      • Action Command
      • Composite Command
      • Gain Currency Command
      • Gain Experience Command
      • Gain Item Command
      • Learn Ability Command
      • Load Scene Command
      • Set Level Command
    • Class Specialization
    • Combat Strategy
    • Credits Category
    • Currency
    • Currency Group
    • Cutscene
    • Dialog
    • Environment State Profile
    • Equipment Model Profile
    • Equipment Set
    • Equipment Slot Profile
    • Equipment Slot Type
    • Faction
    • Interactable Option Configurations
      • Bank Config
      • Behavior Config
      • Character Creator Config
      • Class Change Config
      • Crafting Node Config
      • Cutscene Config
      • Dialog Config
      • Faction Change Config
      • Gathering Node Config
      • Item Pickup Config
      • Load Scene Config
      • Lootable Character Config
      • Moveable Prefab Config
      • Music Player Config
      • Name Change Config
      • Patrol Config
      • Quest Giver Config
      • Skill Trainer Config
      • Specialization Change Config
      • Teleport Config
      • Unit Spawn Controller Config
      • Vendor Config
    • Items
      • Action Effect Item
      • Armor
      • Bag
      • Currency Item
      • Equipment
      • Food
      • Power Resource Potion
      • Quest Start Item
      • Recipe Item
      • Weapon
    • Item Quality
    • Loot Table
    • Material Profile
    • Patrol Profile
    • Power Resource
    • Prefab Profile
    • Quest
    • Quest Giver Profile
    • Recipe
    • Resource Description
    • Scene Node
    • Scriptable Content Template
    • Skill
    • Status Effect Group
    • Status Effect Type
    • Swappable Mesh Model Profile
    • UMA Model Profile
    • Unit Prefab Profile
    • Unit Profile
    • Unit Toughness
    • Unit Type
    • Vendor Collection
    • Voice Profile
    • Weather Profile
    • Weapon Skill
  • MONOBEHAVIOURS
    • Monobehaviours Introduction
    • Scene Config
    • Channeled Object Script
    • Channeled Cylinder Script
    • Edible Object
    • Projectile Script
    • Cutscene Camera Controller
    • Playable Director Controller
    • Spawnable
    • Interactable
    • Interactable Options
      • Animated Object
      • Bank
      • Behavior Interactable
      • Character Creator Interactable
      • Class Change Interactable
      • Click Switch
      • Crafting Node
      • Cut Scene Interactable
      • Dialog Interactable
      • Faction Change Interactable
      • Gathering Node
      • Item Pickup
      • Load Scene Interactable
      • Lootable Character
      • Moveable Object
      • Moveable Prefab
      • Music Player
      • Name Change Interactable
      • Pressure Switch
      • Quest Giver
      • Skill Trainer
      • Specialization Change Interactable
      • Teleport Interactable
      • Unit Spawn Controller Interactable
      • Vendor
    • Environmental Effect Area
    • Movement Sound Area
    • Persistent Object
    • Respawn Area
    • Unit Spawn Node
    • Water Body
  • Architecture
    • Ability System
      • Abilities
      • Ability Effects
    • Project Settings
      • Layers
      • Tags
      • Physics Settings
  • Shared Properties
    • Capabilities
    • Environment Preview
    • Prerequisite Conditions
    • Stat Scaling Nodes
Powered by GitBook
On this page
  1. Scriptable Objects

Scriptable Objects Introduction

PreviousRename WizardNextAbilities

Last updated 2 years ago

The AnyRPG Engine makes heavy use of to allow as much configuration of games as possible without requiring changes to the engine code.

Properties

All scriptable objects used in AnyRPG have a common set of shared properties. To avoid duplication in the documentation, they are all listed here. Individual scriptable object pages will only list additional properties that are not on this page.

Name
Description

Resource Name

The resource name serves as a database key when scriptable object lookups are performed in the engine. If the Display Name field is empty, it will also be the display text wherever the item appears in-game.

Display Name

The display name field can be used when a different display text than the Resource Name is desired, or when using localization to display text in different languages.

Icon

Whenever the UI will show an image for a certain scriptable object, this icon will be used.

Icon Background Image

If an icon is transparent, this image will show behind the icon. This can be useful to reduce effort and save space, by re-using background images for multiple icons.

Description

Whenever the UI shows a description for a scriptable object, this text will be displayed.

Use Regional Description

If true, the system will search for a localized regional description for this scriptable object and use its Display Name, Icon, Icon Background Image, and Description instead.

Resource Description Profile

If set, the system will search for a regional description with this name for this scriptable object and use its Display Name, Icon, Icon Background Image, and Description instead.

Optional Override

If true, and one of the two regional override fields is used, the regional override is optional, and will not cause an error if it doesn't exist.

Unity Scriptable Objects