HytaleDocs
Objective

Objectives

Asset path: Server/Objective/Objectives/*.json

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another ObjectiveAsset most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Tags

Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.

For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.

Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of String

Category

Type information: (Nullable) String

TaskSets

Type information:

Array of the type:

TaskSet with the following properties:

KeyTypeDescription
DescriptionId(Nullable) String
TasksArray of the type: Type Selector

Completions

Type information:

(Nullable) Array of the type: Any of these:

Key: TypeType
ClearObjectiveItems
ClearObjectiveItemsCompletionAsset

ClearObjectiveItemsCompletionAsset with the following properties:

KeyTypeDescription
TypeConstant value: ClearObjectiveItems

This field controls the type, it must be set to the constant value "ClearObjectiveItems" to function as this type.

GiveItems
GiveItemsCompletionAsset

GiveItemsCompletionAsset with the following properties:

KeyTypeDescription
TypeConstant value: GiveItems

This field controls the type, it must be set to the constant value "GiveItems" to function as this type.

DropListEither String or ItemDropList

Reference to a ItemDropList asset

Reputation
ReputationCompletionAsset

ReputationCompletionAsset with the following properties:

KeyTypeDescription
TypeConstant value: Reputation

This field controls the type, it must be set to the constant value "Reputation" to function as this type.

ReputationGroupIdString

Reference to a ReputationGroup asset

AmountInteger defaults to: 1

TitleId

Type information: (Nullable) String

DescriptionId

Type information: (Nullable) String

RemoveOnItemDrop

Type information: Boolean defaults to: false

Notes:

Types referenced by this type

Type Selector

Any of these:

Key: TypeType
Bounty
BountyObjectiveTaskAsset

BountyObjectiveTaskAsset with the following properties:

KeyTypeDescription
TypeConstant value: Bounty

This field controls the type, it must be set to the constant value "Bounty" to function as this type.

DescriptionId(Nullable) String
TaskConditions(Nullable) Array of the type: SoloInventoryCondition
MapMarkerPositions(Nullable) Array of the type: Vector3i
NpcId(Nullable) String
WorldLocationConditionLocationRadiusProvider
Craft
CraftObjectiveTaskAsset

CraftObjectiveTaskAsset with the following properties:

KeyTypeDescription
TypeConstant value: Craft

This field controls the type, it must be set to the constant value "Craft" to function as this type.

DescriptionId(Nullable) String
TaskConditions(Nullable) Array of the type: SoloInventoryCondition
MapMarkerPositions(Nullable) Array of the type: Vector3i
CountInteger defaults to: 1
ItemIdString

Reference to a Item asset

Gather
GatherObjectiveTaskAsset

GatherObjectiveTaskAsset with the following properties:

KeyTypeDescription
TypeConstant value: Gather

This field controls the type, it must be set to the constant value "Gather" to function as this type.

DescriptionId(Nullable) String
TaskConditions(Nullable) Array of the type: SoloInventoryCondition
MapMarkerPositions(Nullable) Array of the type: Vector3i
CountInteger defaults to: 1
BlockTagOrItemIdBlockTagOrItemIdField
KillNPC
KillObjectiveTaskAsset

KillObjectiveTaskAsset with the following properties:

KeyTypeDescription
TypeConstant value: KillNPC

This field controls the type, it must be set to the constant value "KillNPC" to function as this type.

DescriptionId(Nullable) String
TaskConditions(Nullable) Array of the type: SoloInventoryCondition
MapMarkerPositions(Nullable) Array of the type: Vector3i
CountInteger defaults to: 1
NPCGroupIdString

Reference to a NPCGroup asset

KillSpawnBeacon
KillSpawnBeaconObjectiveTaskAsset

KillSpawnBeaconObjectiveTaskAsset with the following properties:

KeyTypeDescription
TypeConstant value: KillSpawnBeacon

This field controls the type, it must be set to the constant value "KillSpawnBeacon" to function as this type.

DescriptionId(Nullable) String
TaskConditions(Nullable) Array of the type: SoloInventoryCondition
MapMarkerPositions(Nullable) Array of the type: Vector3i
CountInteger defaults to: 1
NPCGroupIdString

Reference to a NPCGroup asset

SpawnBeaconsArray of the type: ObjectiveSpawnBeacon
KillSpawnMarker
KillSpawnMarkerObjectiveTaskAsset

KillSpawnMarkerObjectiveTaskAsset with the following properties:

KeyTypeDescription
TypeConstant value: KillSpawnMarker

This field controls the type, it must be set to the constant value "KillSpawnMarker" to function as this type.

DescriptionId(Nullable) String
TaskConditions(Nullable) Array of the type: SoloInventoryCondition
MapMarkerPositions(Nullable) Array of the type: Vector3i
CountInteger defaults to: 1
NPCGroupIdString

Reference to a NPCGroup asset

Radius(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
SpawnMarkerIdsArray of String

Reference to a SpawnMarker asset

ReachLocation
ReachLocationTaskAsset

ReachLocationTaskAsset with the following properties:

KeyTypeDescription
TypeConstant value: ReachLocation

This field controls the type, it must be set to the constant value "ReachLocation" to function as this type.

DescriptionId(Nullable) String
TaskConditions(Nullable) Array of the type: SoloInventoryCondition
MapMarkerPositions(Nullable) Array of the type: Vector3i
TargetLocationString

Reference to a ReachLocationMarkerAsset asset

UseBlock
UseBlockObjectiveTaskAsset

UseBlockObjectiveTaskAsset with the following properties:

KeyTypeDescription
TypeConstant value: UseBlock

This field controls the type, it must be set to the constant value "UseBlock" to function as this type.

DescriptionId(Nullable) String
TaskConditions(Nullable) Array of the type: SoloInventoryCondition
MapMarkerPositions(Nullable) Array of the type: Vector3i
CountInteger defaults to: 1
BlockTagOrItemIdBlockTagOrItemIdField
UseEntity
UseEntityObjectiveTaskAsset

UseEntityObjectiveTaskAsset with the following properties:

KeyTypeDescription
TypeConstant value: UseEntity

This field controls the type, it must be set to the constant value "UseEntity" to function as this type.

DescriptionId(Nullable) String
TaskConditions(Nullable) Array of the type: SoloInventoryCondition
MapMarkerPositions(Nullable) Array of the type: Vector3i
CountInteger defaults to: 1
TaskIdString
AnimationIdToPlay(Nullable) String
Dialog(Nullable) DialogOptions

On this page