Report types & Reasons
You can configure the reports section to act in different ways. Below I will explain the different ways of setting up the report configuration.
1. No predefined reasons, No Types
This is the default configuration for reports.
reports-module:
enabled: true
...
fixed-reason: false
fixed-reason-culprit: false
report-types: []
reasons: []
...When configured like this, a player can create a report in the following ways:
/report <reason>
/reportplayer <playername> <reason>
2. No predefined reasons, predefined Types
You can configure report-types underneath the reports-module. This is completely optional. If you do configure them the player creating the report will get a selection screen where he must select his report type.
When configured like this, a player can create a report in the following ways:
/report <reason>
/reportplayer <playername> <reason>
After executing the command the select type GUI will be shown.
Every report type must define a name. Optionally you can also define info which will be displayed as lore of the item and a material.
Predefined Reasons, No types
You can define predefined reasons for reports. When reasons are defined a player can create a report in the following ways:
/report <reason?>
/reportplayer <player> <reason?>
Notice that the reason becomes optional in this scenario. If the player does not provide a reason, the reason select GUI will be shown. You can make it so that the GUI always shows up by setting the fixed-reason to true.
Every report reason must define a reason. Optionally you can also define info which will be displayed as lore of the item and a material. you can also define a type, this is also optional. If you define a type, this type will be stored inside the database if the user selects this reason through the GUI.
4. Predefined reasons, Predefined types
When configuring the reports in this way a player can create a report in the following ways:
/report <reason?>
/reportplayer <player> <reason?>
Reason is optional in this scenario. If reason is provided only the select type GUI is shown. If the player does not provide a reason then first the select Type GUI is shown, and based on the Type select the Select Reason GUI is shown.
In this setup `type` for report reasons is mandatory! The type must be the same as the one defined in the report types.
Filters
Both reasons as report types can define a filter "culprit". You can use this filter to decide if reasons or types should be visible depending the fact if a player got reported or not. When the filter is not defined they will be shown with both.
Last updated
Was this helpful?