Unit Profile

A unit profile defines all the information related to a character, including both the character configuration, and properties of the physical model.

Creation

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

Properties

The default properties of a character unit are listed below. Some of these properties can be overridden if this character is used as a player.

Unit Prefab

NameDescription

Automatic Prefab Profile

If true, the unit prefab is loaded by searching for a UnitPrefabProfile with the same name as this resource.

Prefab Profile Name

The name of the prefab profile that contains the prefab that represents this unit. Only used if Automatic Prefab Profile and Use Inline Prefab Props are not true.

Use Inline Prefab Props

If true, the unit prefab is loaded from the inline Unit Prefab Props field.

Unit Prefab Props

Unit Settings

NameDescription

Is UMA Unit

Deprecated, not currently used.

Is Pet

If true, this unit can be captured and kept as a pet.

Flight Capable

If true, this unit can fly.

Glide Capable

If true, this unit can glide.

Character

NameDescription

Character Name

The name of the character, which will be shown in unit frames and nameplates.

Title

A title that will be shown below the name in the nameplate.

Faction Name

The name of the Faction that this character belongs to.

Unit Type Name

The name of the Unit Type of this character.

Character Race Name

The name of the Character Race of this character.

Character Class Name

The name of the Character Class of this character.

Class Specialization Name

The name of the Class Specialization of this character.

Spawn Dead

If true, the character will spawn dead.

Prevent Auto Despawn

If true, the character will not despawn when it does.

Default Toughness

The name of a Unit Toughness that defines how tough the character is.

Voice

NameDescription

Voice Profile

A Voice Profile that contains voice audio clips to play.

Use Inline Voice Props

If true, the Voice Profile is loaded from the inline settings below, instead of the shared voice profile above.

Voice Props

If Use Inline Voice Props is true, the Voice Profile Properties here will be used instead of the shared Voice Profile above.

Configuration

NameDescription

Capabilities

Capabilities the character has.

Primary Stats

Power Resources

A list of Power Resources the character has.

Use Provider Equipment

By default NPCs only equip the Equipment listed in the Equipment Name List. If true, NPCs will equip all Equipment from any provider, including Character Class, Faction, etc.

Equipment Name List

A list of Equipment that the character will have equipped by default.

Combat

NameDescription

Is Aggressive

If true, the unit will attack anything in its aggro radius, based on the Faction relationship.

Aggro Radius

The radius of the aggro sphere around this unit. Set to 0 to disable aggro.

Automatic Combat Strategy

If true, a Combat Strategy matching the unit name will be looked up, and used if found.

Combat Strategy Name

The name of a Combat Strategy to use.

Default Hit Effects

Ability Effects to cast on the target when the performing an unarmed standard (auto) attack.

Movement

NameDescription

Is Mobile

If true, the character can move.

Footstep Type

None

Do not play footsteps.

Unit

Play the footsteps configured below. Environment

Play the footsteps based on the terrain. UnitFallback

Try environment, then fallback to unit if no environment sound available. Both Play environment and unit sounds at the same time.

Play On Footstep

If true, individual footstep sounds will play when the foot hits the ground, instead of playing a repeating footsteps loop when moving.

Movement Audio Profile Names

A list of Audio Profiles that contain audio clips that will be played when the unit is in motion. If Play On Footstep is true, the audio clips will by cycled through as the feet hit the ground.

Patrol

NameDescription

Use Inline Patrol

If true, the patrol defined in the Patrol Config field will be used.

Patrol Config

Patrol properties.

Patrol Names

The names of Patrol Profiles to use.

Interaction

NameDescription

Face Interaction Target

If true, and the character is an NPC, it will turn and face any player that interacts with it.

Interaction Max Range

The maximum range at which this character can be interacted with if it is an NPC.

Interactable Options

A list of named Interactable Options that define which Interactables this character has, if it is an NPC.

Inline Interactable Options

Interactable Option Configurations that define which Interactables this character has, if it is an NPC.

Object Persistence

NameDescription

Persist Object Position

If true, the object position is saved so that the object will spawn at the saved location next time a game is loaded. This requires at least one of Save On Level Unload, Save On Game Save, or a save setting in a Patrol to be true.

Save On Level Unload

If true, the position will be saved when a level is unloaded.

Save On Game Save

If true, the position will be saved when the game is saved.

Overwrite Unit UUID

If true, the automatic UUID assigned to the unit will be overwritten with the UUID in the UUID field.

UUID

An automatically created Universally Unique Identifier used to ensure that all objects with saved position data do not overwrite another object's data.

Next Steps

  • Add a unit profile to the Default Player Unit Profile Name field in the System Configuration Manager to make this unit the default when a new game is started.

  • Add a unit profile to the Character Creator Profile Names list in the System Configuration Manager to allow a player to choose this unit from a list of units when starting a new game.

  • Add a unit profile to the Character Creator Profile Names list in a Faction to allow a player to choose this unit from a list of units when starting a new game as a specific Faction.

Last updated