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
  • Creation
  • Properties
  • Next Steps
  1. Scriptable Objects

Patrol Profile

A patrol profile defines where and how a character will patrol, including locations, timing, and speed.

PreviousMaterial ProfileNextPower Resource

Last updated 2 years ago

Creation

To create a material profile, find (or create) the GameName/Resources/GameName/PatrolProfile folder in the project tab and right click. Choose Create > AnyRPG > PatrolProfile.

Properties

A patrol profile contains a single property, Patrol Properties, which consists of the following properties.

Name
Description

Auto Start

If true, a character unit that uses this patrol will start the patrol automatically upon spawning or entering the patrol state.

Destination List

A list of Vector3 coordinates that the unit will patrol to.

Use Tags

If true, the unit will patrol to the destinations in the Destination Tag List instead of the destination list. This is useful if the level geometry will change because it doesn't require re-creating the destination list.

Destination Tag List

A list of tags. The current scene will be searched for these tags, and the unit will patrol to the location of the tags.

Random Destinations

If true, destinations will be chosen randomly from the active destination list, rather than visited sequentially in order.

Loop Destinations

If true, the patrol will continue indefinitely, re-starting at the first destination when the last destination is reached.

Despawn On Completion

If true, the unit will despawn when the last destination is reached.

Max Destinations

If set to any number other than 0 (infinite), the patrol will end after that number of destinations have been reached.

Max Distance From Spawn Point

If the destination list is empty, and Random Destinations is set to true, a random location that is less than or equal to this number of meters from the spawn point will be chosen.

Destination Pause Time

The amount of time, in seconds, that a unit will pause at each destination before continuing to the next destination.

Movement Speed

The speed, in meters per second, that the unit will travel at when patrolling.

Save Position At Destination

If true, the unit will attempt to save its position when it reaches a destination. The next time a saved game is loaded, the unit will start at the saved position, instead of its usual spawn point.

Next Steps

Assign a Patrol Profile to a .

Unit Profile