← Previous | Next →
QUEST
Description
Creates a quest thats gives a reward when completed.
Attributes
Attribute id
| Name |
Required |
Description |
Parameters |
| id |
Yes |
The quest ID. |
1 |
Parameters of id
| # |
Name |
Type |
Description |
Multiple |
| 1 |
ID |
String |
The ID of the quest. |
No |
Attribute name
| Name |
Required |
Description |
Parameters |
| name |
Yes |
The name of the quest. |
1 |
Parameters of name
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Name |
String |
The name of the quest. |
No |
Attribute description
| Name |
Required |
Description |
Parameters |
| description |
Yes |
The description of the quest explaining what it's about. |
1 |
Parameters of description
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Description |
String |
The description of the quest. |
No |
Attribute author
| Name |
Required |
Description |
Parameters |
| author |
Yes |
The author of the quest. |
1 |
Parameters of author
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Author |
String |
The author of the quest. |
No |
Attribute duration
| Name |
Required |
Description |
Parameters |
| duration |
Yes |
The duration of the quest. |
1 |
Parameters of duration
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Duration |
Number |
The approximate duration of the quest in minutes. |
No |
Attribute profile
| Name |
Required |
Description |
Parameters |
| profile |
Yes |
The profile of players that the mission is aimed at. |
1 |
Parameters of profile
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Profile |
String |
The profile of the quest. |
No |
Attribute category
| Name |
Required |
Description |
Parameters |
| category |
Yes |
The category of the quest. |
1 |
Parameters of category
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Category |
String |
The category of the quest, use 'SIDE'. |
No |
Attribute coords
| Name |
Required |
Description |
Parameters |
| coords |
No |
The coordinates of the quest. |
3 |
Parameters of coords
| # |
Name |
Type |
Description |
Multiple |
| 1 |
X |
Number |
The X position of the quest. |
No |
| 2 |
Y |
Number |
The Y position of the quest. |
No |
| 3 |
Z |
Number |
The Z position of the quest. |
No |
Attribute theme
| Name |
Required |
Description |
Parameters |
| theme |
Yes |
The theme of the quest with one or two words |
1 |
Parameters of theme
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Theme |
String |
The theme of the quest. |
No |
Attribute context
| Name |
Required |
Description |
Parameters |
| context |
Yes |
The context of the quest that will be given to the players. |
1 |
Parameters of context
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Context |
String |
The context of the quest. |
Yes |
Attribute success
| Name |
Required |
Description |
Parameters |
| success |
Yes |
The message that will be shown when the quest is completed. |
1 |
Parameters of success
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Success |
String |
The success message of the quest. |
Yes |
Attribute failure
| Name |
Required |
Description |
Parameters |
| failure |
Yes |
The message that will be shown when the quest is failed. |
1 |
Parameters of failure
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Failure |
String |
The failure message of the quest. |
Yes |
Attribute required
| Name |
Required |
Description |
Parameters |
| required |
No |
The required quests to start this quest. |
1 |
Parameters of required
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Required |
Quest ID |
The required quests to start this quest. |
No |
Attribute minParticipants
| Name |
Required |
Description |
Parameters |
| minParticipants |
No |
The minimum number of participants. |
1 |
Parameters of minParticipants
| # |
Name |
Type |
Description |
Multiple |
| 1 |
MinParticipants |
Number |
The minimum number of participants. |
No |
Attribute maxParticipants
| Name |
Required |
Description |
Parameters |
| maxParticipants |
No |
The maximum number of participants. |
1 |
Parameters of maxParticipants
| # |
Name |
Type |
Description |
Multiple |
| 1 |
MaxParticipants |
Number |
The maximum number of participants. |
No |
Attribute participants
| Name |
Required |
Description |
Parameters |
| participants |
if |
not |
1 |
Parameters of participants
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Participants |
Number |
The number of participants. |
No |
Attribute goals
| Name |
Required |
Description |
Parameters |
| goals |
Yes |
The goals of the quest defined as a tree. |
1 |
Parameters of goals
| # |
Name |
Type |
Description |
Multiple |
| 1 |
GoalsTree |
GoalsTree |
The goals of the quest. |
No |
Attribute impediments
| Name |
Required |
Description |
Parameters |
| impediments |
No |
The impediments of the quest defined as a tree. |
1 |
Parameters of impediments
| # |
Name |
Type |
Description |
Multiple |
| 1 |
ImpedimentsTree |
ImpedimentsTree |
The impediments of the quest. |
No |
Attribute rewards
| Name |
Required |
Description |
Parameters |
| rewards |
No |
The rewards of the quest defined as a list. |
1 |
Parameters of rewards
| # |
Name |
Type |
Description |
Multiple |
| 1 |
RewardsList |
RewardsList |
The rewards of the quest. |
No |
Attribute requirements
| Name |
Required |
Description |
Parameters |
| requirements |
No |
The requirements of the quest defined as a list that reprensent something that all players must have to start quest. |
1 |
Parameters of requirements
| # |
Name |
Type |
Description |
Multiple |
| 1 |
RequirementsList |
RequirementsList |
The requirements of the quest. |
No |
Attribute uniqueRequirements
| Name |
Required |
Description |
Parameters |
| uniqueRequirements |
No |
The unique requirements of the quest defined as a list that reprensent something at least one player in group must have to start quest. |
1 |
Parameters of uniqueRequirements
| # |
Name |
Type |
Description |
Multiple |
| 1 |
UniqueRequirementsList |
UniqueRequirementsList |
The unique requirements of the quest. |
No |
Attribute conditions
| Name |
Required |
Description |
Parameters |
| conditions |
No |
The conditions of the quest defined as a list that represent some global condition not associated directly with players starting quest, must not be breached before starting or during the quest. |
1 |
Parameters of conditions
| # |
Name |
Type |
Description |
Multiple |
| 1 |
ConditionsList |
ConditionsList |
The conditions of the quest. |
No |
Attribute limit
| Name |
Required |
Description |
Parameters |
| limit |
No |
The time limit to finish quest when it started. |
1 |
Parameters of limit
| # |
Name |
Type |
Description |
Multiple |
| 1 |
Limit |
Number |
The limit of the quest in minutes. |
No |
Attribute compensations
| Name |
Required |
Description |
Parameters |
| compensations |
No |
The compensations of the quest defined as a list that represent what players must give to be able to start quest. |
1 |
Parameters of compensations
| # |
Name |
Type |
Description |
Multiple |
| 1 |
CompensationsList |
CompensationsList |
The compensations of the quest. |
No |
Example
MISION
id example_quest
name "Talk to Mark and Mike"
description "Talk to Mark and Mike"
duration 10
author Sergiolp
profile Anybody
theme General
category SIDE
context "Talk to Mark and Mike" "Avoid talking to Steven"
success "Congratulations! You have completed the quest."
failure "You have failed the quest."
participants 1
goals
talkNPC 1 "Talk to Mark" npc=Mark
talkNPC (1) "Talk to Mike" npc=Mike
impediments
talkNPC 1 "Do not talk with Steven" npc=Steven
rewards
item 1 water
money 50
requirements
money 50
limit 10
compensations
item 1 water