Overview
This is a script i made for Aegorin.de.
Its purpose is to enable Players to rent houses in the main town of the Kingdom faction. I added some extra flexibility so it could potentually be used for other towns and purposes.
Documentation
Description
The rental system is intended to support the Kingdom faction on the new map in distributing houses to residents.
Permissions
aegorin.script.rent.user
= Grants access to the rent command, which includes all player commands.
aegorin.script.rent.mod
= Grants access to the rmod command, which includes the moderator commands for the rental system.
aegorin.script.rent.dev
= Grants access to the developer commands, allowing creation and deletion of rentable regions.
Player Commands
/rent
Displays help for using the command.
Alias: –
Permission: aegorin.script.rent.user
/rent info
Gives the player an overview of all their rented regions.
/rent info <housename>
Gives the player more detailed information about one of their regions.
/rent notify <enable/disable>
Enables or disables notifications when entering rentable areas.
/rent claim <housename>
Allows the player to rent the area they are currently standing in (if available).
/rent unclaim <housename>
Allows the player to cancel the rent or stop renting a region.
/rent add <housename> <playername>
Allows the player to grant another player access/rights to their rented region.
/rent remove <housename> <playername>
Allows the player to remove another player from their house / revoke their rights.
Moderator Commands
/rmod
Displays help for using the command.
Alias: –
Permission: aegorin.script.rent.mod
/rmod info <playername>
Displays a general overview of the player’s rented houses.
/rmod info <playername> <house>
Displays detailed information about a specific house owned by a player.
/rmod log <playername>
Provides the moderator with a log (up to 30 days) showing what the player has done with the rental system.
/rmod area
If active, gives the mod detailed info about a rented house when entering or flying into the region.
/rmod disable <playername>
Blocks a player from using the rental system.
/rmod enable <playername>
Removes the block and allows the player to use the rental system again.
/rmod removePlayer <player1> <housename> <player2>
Removes the rights of player2 to access the house of player1.
/rmod removeClaim <playername> <housename> <true/false>
Warning: This command removes a player from a rentable region and may reset it!
Used to terminate a player’s rental.
If true (which is the default when omitted), the house will be properly reset and all changes inside will be undone.
If false, the player is removed, but the house remains unchanged.
Special Commands
/rdev
Used to create and delete rentable regions.
Alias: /rd
Permission: aegorin.script.rent.dev
/rdev create <playername/Elandar> <rent> <rentalcycle> <regionname/-suffix>
Creates a rentable region if standing in a valid WorldGuard region.
Valid rental cycles: Monthly / Daily
Rent: Any number of Drachma to be deducted per cycle.
If Elandar is used as the player name, the landlord is not a player, meaning the Drachma will go to no one.
<regionname> is the name following rrg_elandar_. For example, haus_1. Use /rg list to check if a region like rrg_elandar_haus_1 already exists.
After creation, gold blocks will mark the detected region.
/rdev delete
Deletes the rentable region you are currently standing on.
