Overhaul List: Objectives (Tasks)

[KingJulian13]

Objective Overhaul

Part of the full Events, Conditions, Objectives, Variables Overhaul

What this is: This is the full and updated list of Objectives how they will be implemented after the overhaul.
Explanation: Arguments in <> are mandatory, [] is optional, CAPS are keywords.
Contributing changes and new objectives: Join the discussion by commenting.

Also in general objectives should be cancelable if possible.

Objectives should be able to return a list of all things that allow to progress the objective.
For example, if an objective uses a Block Selector such a variable would return all blocks that are matched: "OAK_LOG, SPRUCE_LOG"
This makes it possible to display better objective notify messages. #1295 (comment)

Unmodified Objectives

• die
• craft
• smelt
• tame
• delay
• experience
• step
• logout
• login
• password
• enchant
• shear
• chestput
• brew
• vehicle
• kill
• respawn
• breed
• jump
• npckill
• npcinteract
• npcrange
• nujobs_joinjob
• nujobs_leavejob
• nujobs_levelup
• nujobs_payment
• mmoprofessionlevelup
• mmocorecastskill
• mmocorebreakblock
• mmoitemcraft
• mmoitemupgrade
• mmoitemapplygem
• mmoitemcastability
• mmobkill
• region

Modified Objectives

• arrow -> projectile
  • Any projectile can be used, a desired type can be specifed
• delay -> wait
  • Some users want to count online time only. Let's also allow the reverse use case using these two new arguments! Default value is true for both.
  • New argument: countOnline:<true/false>
  • New Argument: countOffline:<true/false>
• pickup
  • Items, that dont count twice, if they are droped and pickuped again
  • Refering: Advanced "Pickup" Objective Filter #1292
• fish
  • add cancel option to cancel the drop if the fish
  • Refering: New Option on Fish objective (cancel) #1320
• action
  • add store location in Variable
  • Refering: Clicked block in "action" objective as a property #475
• consume
  • Add a quantity to consule X times a item
  • Refering: Adding a quantity to the consume objective #969
• interact
  • Add an interaction limit to prevent double interactions
  • Add player support to trigger events for the clicked player
  • Add support for specific MythicMobs as a mob type
  • Refering: [Feature] Interact with players Objective #604
• block
  • May split them in blockplace and blockbreak
  • add a Location where the blocks must be broken or placed
  • left amount without negative numbers
  • Objective property for all block that match the regex
  • Allow blocking of placed blocks to get count. PDC (Persistent Data Containers) could solve this
    • keep in mind that some server may dont want this if they for example regenerate resources
  • Refering: Objective block location #643 Block objective: Property "left" dsiplaying negative Numbers #495 Block break and place objectives #786
• command
  • The ability to register a command description thats shown in /help.
  • Refering: Adding an objective for using a command #912
• mobkill
  • add property for the next player in a radius like in the mmobkill objective
  • add property for the spawn reason
  • add a way to select multiple or any mob.
  • Refering: When a mob die, i'm looking a way to valid objectives of players close #802
• mmobkill
  • add a way to select multiple or any mob.

Removed Objectives

• variable

New Objectives

• readBook [pageNumber] Completed if a specified book or the journal is opened, optionally if a the player clicked through until page X.
  • Refering: Add objective "open book" #1076,#1502
• globaldelay like the delay objective but global
  • Refering: Feature request: GlobalDelay objective #943
• chesttake equal to chestput
  • Refering: objective take item in a chest #897
• item
  • The player need a specified amount of items in his inventory
  • Refering: Item objective #1014
• damageEntity
  • give an entity an amount of damabe
• drop
  • Completed when a specified amount of items has been dropped. An optional location + radius can also be set.
  • private: use protocollib to hide the item from other players.
  • indestructible: Prevent the item from despawning.
  • Refering: Drop Item Event/Condition/Objective #1018
• location
  • The location objective should be able to accept just a world or just a dimension name.

[seyfahni]

How can we differentiate between a block objective for placing stripped wood and a block (or other?) objective for stripping spruce wood?

Some possible solutions:

• Ignore stripping wood inside the blockobjective and add a new strip_wood (or similar) objective
  Downside: Actions like stripping wood are not that young (creating farmland is similar) but as opposed to farmland you can obtain stripped wood in survival
• Add a new parameter to the block objective to allow matching the replaced block.
  Downside: It has to be negateable, as normal block placement can replace air, cave air, fern, tall grass, water, lava etc.

[KingJulian13]

Ignore stripping wood inside the block objective and add a new strip_wood (or similar) objective

I would consider making the objective more versatile and naming it something like transform_block or replace_block to cover wood stripping, farmland and potentially upcoming block transformations

Add a new parameter to the block objective to allow matching the replaced block.

If I understand that right: Something like a to:some_block parameter that is optional (default = air(s) [Possible Edgecases to be decided here?])
This should then allow a list of blocks that the block can be replaced to to:block1,block2,block3

An additional boolean property for specifically including or excluding block-replacement in the block objective should be reasonable independent to prior solutions in order to promote slim code. E.g. include_transform (Couldn't come up with anything better right now.)

[seyfahni]

You called it to but what I meant was something matching the block that was there before, so I'll be talking about the from parameter.

If I understand that right: Something like a to:some_block parameter that is optional (default = air(s) [Possible Edgecases to be decided here?])

I wouldn't say that the optional fromparameter should default to air(s) or something else but instead be a match all, so to say not restricting how it is achieved but allowing to make that restriction.

This should then allow a list of blocks that the block can be replaced to to:block1,block2,block3

This is already possible by using the block selector, though in principle you're right. The part that I worry most about is the negation of it, say from anything except this block as it would allow you to exclude stripping.

An additional boolean property for specifically including or excluding block-replacement in the block objective should be reasonable independent to prior solutions in order to promote slim code. E.g. include_transform (Couldn't come up with anything better right now.)

That is a nice way to handle it, but it still isn't future-safe as we then would have to manually maintain a list of all possible transformation, which will quickly get out of date.

I would consider making the objective more versatile and naming it something like transform_block or replace_block to cover wood stripping, farmland and potentially upcoming block transformations

The same logic also applies to adding a new objective for block transformations of course.

So I tend to prefer the from solution exclusively as it is much more versatile and future proof as quest creators can exclude new transformations without us having to do anything.

[Revanrose6]

As you're adding damageEntity I think it would also be cool to add playerDamage. So you can make quests that fail if a player takes more than a specified amount of damage regardless of if they die.

[SaltyAimbOtter]

RE: Chat objectives
By Tenrez

I have a custom plugin that allows Ship vehicles to be named with a command such as /pss name Galleon (name). The problem I am trying to solve is to make it so that players get a message that says something like "Type in chat the name that you would like to give your ship."
I can almost do this with the variable objective and call the name that the player chose with the variable %objective.vtest.% but the problem I have is that I have no way of triggering an event that actually names the ship after the player types the name in chat.
Since the variable objective ignores any defined objectives or conditions
Perhaps is there a workaround to this?
I also tried to set a password objective to the player with the password set as the variable %objective.vtest.% but it won't work because the chat listener of the password objective always takes priority over the variable objective's chat listener.

[Revanrose6]

Objective to use any pressure plate. So you can add random effects/events that only occur if a player steps on any pressure plate instead of one with a specified location.

[KingJulian13]

-> Making location optional on step objective should cover that. Docs

[seyfahni]

-> Making location optional on step objective should cover that. Docs

Also adding the possibility to match the kind of pressure plate would be a good idea.

[Revanrose6]

Add the ability to do Hours on the Delay Objective instead of just minutes/seconds/ticks.

[Zangerine]

It would be a good addition if we could exclude mob kills based on the nature of their spawn. An example being if the mobs have been spawned from a mob spawner they will not count towards the mobkill objective.

[Revanrose6]

Add a way to track when an animal you 'own' kills something. Either as a seperate objective or as an addon to the mobkill objective where you can choose if the kill was 'Player' 'Pet' or if you don't specify, either.

[victoryneM]

Hi here, that should be nice to add such objectives as run, swim, walk or sneak with time or meters as arguments.

[Bossbirdyman51]

Hi ^^ It's possible to add objectif like damage ( When a player receive damage ) ? Thank you ;)

[Nutmegan]

Certain objectives need to have their opposites added.
For Example:
Put on Armor - Take off Armor
Ride Entity - Dismount Entity

Shearing Sheep should be less specific. Sheep should be changed to any defined target. Example, I have a plugin that allows shearing feathers on chickens... I know, it's silly.

[Nutmegan]

Another thing I thought of...
I frequently run into issues with WorldGuard and Action/Interact Objectives
If it's possible to go around WorldGuard and still capture the event as if it was actually interacted with, that would be great. However, I'm not sure if WorldGuard leaves enough details to be able to capture the canceled interaction.

It's probably the same with trying to place/break blocks... not sure if that is ever an issue for people.

[Wolf2323]

I already discussed this issue a while ago with @SaltyAimbOtter
A solution could be, to give the opportunity to modify the priority of the listers (the bukkit event listeners). Then it is possible to change the order of execution compared to other plugins, but also in BetonQuest itself

[MangekyouSasuke]

Hello, is it possible to make an objective on which completes when you meet certain condition? It would be more in general and since there are some conditions which have not been made as objectives (such as points for example), it would be more handy at the time of making some objectives. On the objective would just be:

OBJECTIVE_ID: 'condition CONDITION_ID [events] [condition(which is redundant, but I think it might be useful)]'

[Wolf2323]

I think this will be added in the future with a new system, that checks conditions in a interval and do a when the conditions are met and b otherwise.

The issue with such a system is, that it need much performance compared to an objective. The reason for this is, that a objective in general use minecraft events (they are called when the actual thing happens) and so it only checks for the conditions when something actually changes.

For you point example i normally suggest that you call a second event every time you add points that have the condition for the target amount of wanted points

[SaltyAimbOtter]

This is already possible with the delay objective. You can specify how often to check the condition, how high the accuracy is, what condition is required and what events to execute when the condition is met.

[MangekyouSasuke]

I think this will be added in the future with a new system, that checks conditions in a interval and do a when the conditions are met and b otherwise.

The issue with such a system is, that it need much performance compared to an objective. The reason for this is, that a objective in general use minecraft events (they are called when the actual thing happens) and so it only checks for the conditions when something actually changes.

For you point example i normally suggest that you call a second event every time you add points that have the condition for the target amount of wanted points

1. That's the ifelse objective, that is pretty good, but i meant more like a single if, or if you make only the ifelse one, make b optional.

2. For the points, a points objective would be much more convenient, since what the difference between an event by itself and an objective which runs the same event is that the objective runs the event automatically when the conditions are met. I work with more people on a leveling system with BetonQuest and sometimes, somebody can forget about placing the event. Also, it is really confusing some times when you have to limit some things every X time, our system has a Rank system, each 15 levels you rank up, and we want to make it so every 15th level you need to make an special quest to level up, if you get XP but you haven't made your quest, you won't level up. We use about 5 different points for the leveling system, and sometimes doing it with huge event folders ir really uncomfortable, eventually even I get confused since we got too many things to keep in mind and I am the main lead of the system on the server.

PD: Also, idk if you are already doing this, but at the moment you can only add or subtract and remove points. I would like to be able to set an amount of points, just like you have to add a "global" argument at the end of an objective to make it global, we can add a "set" argument to set it instead of adding at the end of the event. (ik this is not the events section, but I wanted to suggest this too in case this has not been planned yet).

[Nutmegan]

PD: Also, idk if you are already doing this, but at the moment you can only add or subtract and remove points. I would like to be able to set an amount of points, just like you have to add a "global" argument at the end of an objective to make it global, we can add a "set" argument to set it instead of adding at the end of the event. (ik this is not the events section, but I wanted to suggest this too in case this has not been planned yet).

Perhaps I miss what you're suggesting, but the suggestion, while it makes that one task simpler, is very specialized in it's usefulness. If I understand your scenario correctly, couldn't you simply multiply the current points by 0 and then set the points by using the add event? The operators offer a lot more flexibility I think?

[Wolf2323]

With the operators you are complete right, they are planned, but at the moment we we are focused on other tasks.

When i want to set a specific amount of points, i multiply the current one with *0 and then i add the wanted amount.

[MangekyouSasuke]

Hello. Is it possible to make an Advancement objective? I am making a level and rank system and we wanted to give experience when a player gets vanilla or custom advancements. Is there any way to make something like that currently? I mean, like automatically give the player XP when if he has certain advancement without using the delay objective bc it might kill the server with lag

[Wolf2323]

No, there is no Advancement objective, but sounds like we will add it when possible in the future

[AmazonOmega]

I noticed using MCPets plugin that uses MythicMobs and Model Engine always registers pets as tamable creatures or in some example wolfs, when such pet kills the mob in Mythic Mobs its registered as Pet of Player killed the mob, that for some reason does not trigger BQ mmobkill objective, there is a workaround to be used, but that honestly beats the point of party system if you can abuse it diffrently, or what if your pet kills a mob by accident instead of a player. It would be cool to have an objective or maybe an addon to mmobkill objective tamablecreature, that will toggle on if the WOLF or tamable create of a player kills the mob it is registered as a kill from the player it self.
I tried with the dev of MCPets to somehow create a workround but we failed at all attempts, it simply always registers it that way due to MythicMobs registering the kill as such.
That is why I wanted to suggest to add objective tamablecreaturekill or add it as an addon to the objective mmobkill.