Skip to content

Commit 05a291f

Browse files
committed
Add wiki v2 documentation metadata
1 parent db46eb7 commit 05a291f

8 files changed

Lines changed: 72 additions & 5 deletions

File tree

eco-core/core-plugin/src/main/kotlin/com/willfp/ecojobs/libreforge/ConditionHasActiveJob.kt

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package com.willfp.ecojobs.libreforge
22

33
import com.willfp.eco.core.config.interfaces.Config
44
import com.willfp.ecojobs.api.activeJobs
5+
import com.willfp.libreforge.ArgType
56
import com.willfp.libreforge.Dispatcher
67
import com.willfp.libreforge.NoCompileData
78
import com.willfp.libreforge.ProvidedHolder
@@ -11,8 +12,17 @@ import com.willfp.libreforge.get
1112
import org.bukkit.entity.Player
1213

1314
object ConditionHasActiveJob : Condition<NoCompileData>("has_active_job") {
15+
override val description = "Passes when the player has joined the specified job."
16+
17+
override val categories = setOf("player")
18+
1419
override val arguments = arguments {
15-
require("job", "You must specify the job!")
20+
require(
21+
"job",
22+
"You must specify the job!",
23+
description = "The id of the job the player must have joined.",
24+
type = ArgType.STRING
25+
)
1626
}
1727

1828
override fun isMet(

eco-core/core-plugin/src/main/kotlin/com/willfp/ecojobs/libreforge/ConditionHasJobLevel.kt

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import com.willfp.eco.core.config.interfaces.Config
44
import com.willfp.ecojobs.api.event.PlayerJobLevelUpEvent
55
import com.willfp.ecojobs.api.getJobLevel
66
import com.willfp.ecojobs.jobs.Jobs
7+
import com.willfp.libreforge.ArgType
78
import com.willfp.libreforge.Dispatcher
89
import com.willfp.libreforge.NoCompileData
910
import com.willfp.libreforge.ProvidedHolder
@@ -17,9 +18,23 @@ import org.bukkit.event.EventHandler
1718
import org.bukkit.event.EventPriority
1819

1920
object ConditionHasJobLevel : Condition<NoCompileData>("has_job_level") {
21+
override val description = "Passes when the player's level in the specified job is at or above the given level."
22+
23+
override val categories = setOf("player")
24+
2025
override val arguments = arguments {
21-
require("job", "You must specify the job!")
22-
require("level", "You must specify the level!")
26+
require(
27+
"job",
28+
"You must specify the job!",
29+
description = "The id of the job to check the player's level in.",
30+
type = ArgType.STRING
31+
)
32+
require(
33+
"level",
34+
"You must specify the level!",
35+
description = "The minimum level required in the job. Supports expressions.",
36+
type = ArgType.EXPRESSION
37+
)
2338
}
2439

2540
override fun isMet(

eco-core/core-plugin/src/main/kotlin/com/willfp/ecojobs/libreforge/EffectGiveJobXp.kt

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,35 @@ package com.willfp.ecojobs.libreforge
33
import com.willfp.eco.core.config.interfaces.Config
44
import com.willfp.ecojobs.api.giveJobExperience
55
import com.willfp.ecojobs.jobs.Jobs
6+
import com.willfp.libreforge.ArgType
67
import com.willfp.libreforge.NoCompileData
78
import com.willfp.libreforge.arguments
89
import com.willfp.libreforge.effects.Effect
910
import com.willfp.libreforge.triggers.TriggerData
1011
import com.willfp.libreforge.triggers.TriggerParameter
1112

1213
object EffectGiveJobXp : Effect<NoCompileData>("give_job_xp") {
14+
override val description = "Gives the player experience in the specified job."
15+
16+
override val categories = setOf("economy", "player")
17+
1318
override val parameters = setOf(
1419
TriggerParameter.PLAYER
1520
)
1621

1722
override val arguments = arguments {
18-
require("amount", "You must specify the amount of xp to give!")
19-
require("job", "You must specify the job to give xp for!")
23+
require(
24+
"amount",
25+
"You must specify the amount of xp to give!",
26+
description = "The amount of job experience to give to the player. Supports expressions.",
27+
type = ArgType.EXPRESSION
28+
)
29+
require(
30+
"job",
31+
"You must specify the job to give xp for!",
32+
description = "The id of the job to give experience for.",
33+
type = ArgType.STRING
34+
)
2035
}
2136

2237
override fun onTrigger(config: Config, data: TriggerData, compileData: NoCompileData): Boolean {

eco-core/core-plugin/src/main/kotlin/com/willfp/ecojobs/libreforge/FilterJob.kt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,22 @@ package com.willfp.ecojobs.libreforge
22

33
import com.willfp.eco.core.config.interfaces.Config
44
import com.willfp.ecojobs.api.event.JobEvent
5+
import com.willfp.libreforge.ArgType
56
import com.willfp.libreforge.NoCompileData
67
import com.willfp.libreforge.filters.Filter
78
import com.willfp.libreforge.triggers.TriggerData
89

910
object FilterJob : Filter<NoCompileData, Collection<String>>("job") {
11+
override val description = "Matches when the job involved in the triggering event is one of the given job ids."
12+
13+
override val categories = setOf("player")
14+
15+
override val valueType = ArgType.STRING_LIST
16+
17+
override val additionalInfo = listOf(
18+
"Passes automatically when the trigger event is not related to a job."
19+
)
20+
1021
override fun getValue(config: Config, data: TriggerData?, key: String): Collection<String> {
1122
return config.getStrings(key)
1223
}

eco-core/core-plugin/src/main/kotlin/com/willfp/ecojobs/libreforge/TriggerGainJobXp.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ import com.willfp.libreforge.triggers.TriggerParameter
88
import org.bukkit.event.EventHandler
99

1010
object TriggerGainJobXp : Trigger("gain_job_xp") {
11+
override val description = "Fires when the player gains experience in a job."
12+
13+
override val categories = setOf("economy", "player")
14+
1115
override val parameters = setOf(
1216
TriggerParameter.PLAYER,
1317
TriggerParameter.LOCATION,

eco-core/core-plugin/src/main/kotlin/com/willfp/ecojobs/libreforge/TriggerJoinJob.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ import org.bukkit.entity.Player
1010
import org.bukkit.event.EventHandler
1111

1212
object TriggerJoinJob : Trigger("join_job") {
13+
override val description = "Fires when the player joins a job."
14+
15+
override val categories = setOf("player")
16+
1317
override val parameters = setOf(
1418
TriggerParameter.PLAYER,
1519
TriggerParameter.LOCATION,

eco-core/core-plugin/src/main/kotlin/com/willfp/ecojobs/libreforge/TriggerLeaveJob.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ import org.bukkit.entity.Player
1010
import org.bukkit.event.EventHandler
1111

1212
object TriggerLeaveJob : Trigger("leave_job") {
13+
override val description = "Fires when the player leaves a job."
14+
15+
override val categories = setOf("player")
16+
1317
override val parameters = setOf(
1418
TriggerParameter.PLAYER,
1519
TriggerParameter.LOCATION,

eco-core/core-plugin/src/main/kotlin/com/willfp/ecojobs/libreforge/TriggerLevelUpJob.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ import com.willfp.libreforge.triggers.TriggerParameter
88
import org.bukkit.event.EventHandler
99

1010
object TriggerLevelUpJob : Trigger("level_up_job") {
11+
override val description = "Fires when the player levels up in a job."
12+
13+
override val categories = setOf("player")
14+
1115
override val parameters = setOf(
1216
TriggerParameter.PLAYER,
1317
TriggerParameter.LOCATION,

0 commit comments

Comments
 (0)