Skip to content

Commit

Permalink
Updated placeholder descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@A5H73Y
A5H73Y committed Apr 11, 2021
1 parent 69d75a1 commit 932cd07
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 77 deletions.
2 changes: 1 addition & 1 deletion docs/essential/faq.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Parkour is incredibly customisable, allowing you to modify the plugin exactly to

#### ParkourLevel

A Player can earn levels will unlock new Courses for them to join. An example is 'course2' will be locked until they complete 'course1'. The reward can either be an exact level, or an addition to their current level. For example, you can finish all the 'easy' Courses in any order before having enough ParkourLevel to join the 'medium' Courses. The Player's ParkourLevel can never decrease, only increase or remain the same.
A Player can earn levels which will unlock new Courses for them to join. An example is 'course2' will be locked until they complete 'course1'. The reward can either be an exact level, or an addition to their current level. For example, you can finish all the 'easy' Courses in any order before having enough ParkourLevel to join the 'medium' Courses. The Player's ParkourLevel can never decrease, only increase or remain the same.

#### ParkourRank

Expand Down
76 changes: 38 additions & 38 deletions docs/files/parkourPlaceholders.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
{
"placeholder": "%parkour_player_rank%",
"output": "&6Legend",
"description": "The Player's ParkourRank (will have colour applied)."
"description": "The Player's ParkourRank."
},
{
"placeholder": "%parkour_player_parkoins%",
Expand Down Expand Up @@ -64,12 +64,12 @@
{
"placeholder": "%parkour_player_course_completed_(course)%",
"output": "Yes",
"description": "Completion status for whether the Player completed the specified Course. Output configurable in strings.yml."
"description": "Completion status for whether the Player completed the specified Course. Output configurable in strings.yml (PlaceholderAPI.CurrentCourseCompleted & PlaceholderAPI.CurrentCourseNotCompleted)."
},
{
"placeholder": "%parkour_player_prize_delay_(course)%",
"output": "1 day, 2 hours",
"description": "The time delay before the Player can receive the specified Course prize again."
"description": "The time delay before the Player can receive the specified Course prize again. Output configurable in strings.yml (Display.X)."
},
{
"placeholder": "%parkour_player_personal_best_(course)_time%",
Expand All @@ -96,57 +96,57 @@
{
"placeholder": "%parkour_course_displayname_(course)%",
"output": "&4Easy &6Course",
"description": "TODO."
"description": "The display name of the Course, falls back to course name if not set."
},
{
"placeholder": "%parkour_course_record_(course)_time%",
"output": "00:01:23",
"description": "TODO."
"description": "The global best time on the specified Course."
},
{
"placeholder": "%parkour_course_record_(course)_milliseconds%",
"output": "123456",
"description": "TODO."
"description": "The global best time, in milliseconds, on the specified Course."
},
{
"placeholder": "%parkour_course_record_(course)_deaths%",
"output": "3",
"description": "TODO."
"description": "The number of deaths accumulated for the global best time on the specified Course."
},
{
"placeholder": "%parkour_course_record_(course)_player%",
"output": "3",
"description": "TODO."
"description": "The Player's name for the global best time on the specified Course."
},
{
"placeholder": "%parkour_course_completions_(course)%",
"output": "50",
"description": "TODO."
"description": "The number of times the specified Course has been completed."
},
{
"placeholder": "%parkour_course_views_(course)%",
"output": "100",
"description": "TODO."
"description": "The number of times the specified Course has been viewed."
},
{
"placeholder": "%parkour_course_joinfee_(course)%",
"output": "10",
"description": "TODO."
"description": "The economic joining fee when joining the Course."
},
{
"placeholder": "%parkour_course_ecoreward_(course)%",
"output": "100",
"description": "TODO."
"description": "The economic reward for completing the Course."
},
{
"placeholder": "%parkour_course_players_(course)%",
"output": "3",
"description": "TODO."
"description": "The number of online Parkour players on the specified Course."
},
{
"placeholder": "%parkour_course_playerlist_(course)%",
"output": "A5H73Y, steve4744, notch",
"description": "TODO."
"description": "The names of online Parkour players on the specified Course."
}
]
},
Expand All @@ -168,106 +168,106 @@
{
"placeholder": "%parkour_current_course_deaths%",
"output": "3",
"description": "TODO."
"description": "The number of deaths accumulated by the Player so far while on the Course."
},
{
"placeholder": "%parkour_current_course_timer%",
"output": "00:01:23",
"description": "TODO."
"description": "The time accumulated by the Player so far while on the Course, presented in HH:MM:SS."
},
{
"placeholder": "%parkour_current_course_checkpoints%",
"output": "8",
"description": "TODO."
"description": "The total number of checkpoints on the current Course."
},
{
"placeholder": "%parkour_current_course_completed%",
"output": "Yes",
"description": "TODO. (Configurable in 'PlaceholderAPI.CurrentCourseCompleted')"
"description": "Completion status for whether the Player completed the current Course. Output configurable in strings.yml (PlaceholderAPI.CurrentCourseCompleted & PlaceholderAPI.CurrentCourseNotCompleted)."
},
{
"placeholder": "%parkour_current_course_record_time%",
"output": "00:01:23",
"description": "TODO."
"description": "The global best time on the current Course."
},
{
"placeholder": "%parkour_current_course_record_milliseconds%",
"output": "123456",
"description": "TODO."
"description": "The global best time, in milliseconds, on the current Course."
},
{
"placeholder": "%parkour_current_course_record_deaths%",
"output": "3",
"description": "TODO."
"description": "The number of deaths accumulated for the global best time on the current Course."
},
{
"placeholder": "%parkour_current_course_record_player%",
"output": "3",
"description": "TODO."
"output": "A5H73Y",
"description": "The Player's name for the global best time on the current Course."
},
{
"placeholder": "%parkour_current_course_personal_best_time%",
"output": "3",
"description": "TODO."
"output": "00:01:23",
"description": "The Player's best time on the current Course."
},
{
"placeholder": "%parkour_current_course_personal_best_milliseconds%",
"output": "3",
"description": "TODO."
"output": "123456",
"description": "The Player's best time, in milliseconds, on the current Course."
},
{
"placeholder": "%parkour_current_course_personal_best_deaths%",
"output": "3",
"description": "TODO."
"description": "The number of deaths accumulated for the Player's best time on the current Course."
},
{
"placeholder": "%parkour_current_course_remaining_deaths%",
"output": "3",
"description": "TODO."
"description": "The amount of lives remaining on the Course (when a Course has a maximum deaths set)."
},
{
"placeholder": "%parkour_current_checkpoint%",
"output": "3",
"description": "TODO."
"description": "The number of checkpoints achieved by the Player so far while on the Course."
}
]
},
{
"heading": "Leaderboard Placeholders",
"alias": "lb",
"description": "Leaderboard... TODO",
"description": "Find the various leaderboard values.",
"placeholders": [
{
"placeholder": "%parkour_leaderboard_(course)_(position)_time%",
"output": "00:01:23",
"description": "TODO"
"description": "The time on the specified Course, for the given leaderboard position."
},
{
"placeholder": "%parkour_leaderboard_(course)_(position)_milliseconds%",
"output": "123456",
"description": "TODO"
"description": "The time, in milliseconds, on the specified Course, for the given leaderboard position."
},
{
"placeholder": "%parkour_leaderboard_(course)_(position)_deaths%",
"output": "3",
"description": "TODO"
"description": "The number of deaths on the specified Course, given the leaderboard position."
},
{
"placeholder": "%parkour_leaderboard_(course)_(position)_player%",
"output": "A5H73Y",
"description": "TODO"
"description": "The Player name on the specified Course, given the leaderboard position."
}
]
},
{
"heading": "TopTen Placeholders",
"alias": "tt",
"description": "Top Ten... TODO",
"description": "Display a summary of a leaderboard entry. 'TopTen' is a term just to quickly display a summary of the Course's leaderboards, and the position can exceed 10.",
"placeholders": [
{
"placeholder": "%parkour_topten_(course)_(position)%",
"output": "1) A5H73Y TODO",
"description": "TODO"
"output": "&f1) &bA5H73Y&f in &a00:01:23",
"description": "Display a summary of the global leaderboard entry, configurable in the strings.yml to make them themed. (PlaceholderAPI.TopTenResult)"
}
]
}
Expand Down
Loading

0 comments on commit 932cd07

Please sign in to comment.