Locations

Locations RPG Locations

Only MySQL support currently.

The plugin adds locations like in PRG games. Provided fast travel and location opening system with custom events.

Localization
To add a language you need to download the language .loc file and move it to the plugin/Locations/locales/ folder. If you want to use the language as the default (which means that all player who have unsupported languages will see this language) you have to open the locale file and after a comma add the word "default", then do /alocations load locales to load the locale. Also you might add any languages as supported by the locale by adding language code into the "language" field and splitting them with commas. ( ex. language=en_us, en_ud) [ all available language codes]

Locales

• Russian

Commands
Fast travel
/travel < location-name> [ nickname]
Administration
Data control
/alocations save < data>
/alocations load < data>
Location control
/alocations create < location-name>
/alocations remove < location-name>
/alocations info < location-name>
Location setup
/alocations set label < location-name> < label>
/alocations set type < location-name> < type>
/alocations set activity < location-name> < active|inactive>
/alocations set priority < location-name> < priority>
/alocations set position < location-name> < first|second>
/alocations set warp < location-name>
Database control
/alocations database check
/alocations database info
Database setup
/alocations database set database < database>
/alocations database set username < username>
/alocations database set password < password>
/alocations database set url < url>
/alocations database set use < yes|no>

Permissions
/alocations - ksviety.locations.admin
/travel - ksviety.locations.travel
use /travel for other players - ksviety.locations.travel.others
see all existing locations in /travel - ksviety.locations.list

Info
Save and load
Saving/loading data
/alocations save
Stores chosen data to the local storage or database if enabled.
/alocations load
Loads chosen data from the local storage or database if enabled.

Moving data between database and local storage

Local storage to database
/alocations database use no
/alocations load < data>
/alocations database use yes
/alocations save < data>

Database to local storage
/alocations database use yes
/alocations load < data>
/alocations database use no
/alocations save < data>

Provided data types: locations, players, dbconf, locales ("all" to save/load everything)

Location types
At the moment the value might be left on as currently it does not affect on anything at all. Planned to be used for something in future.

Currently available types

• city
• village
• dungeon
• house
• store
• other

Location priority
Does not affect on anything at the moment.
The priority value must be an integer.

Location positions/warp
Positions
Sets chosen position of the location to your current position in the world - generates a cube collider of the location by the scheme below.

Available positions

• first
• second

Warp
Warp is the point where a player that used fast travel is gonna be appeared. The command sets the warp position of the location to your current position in the world. Also might be set via console with specified coordinates after the location name. The warp should be set inside the location because when a player used fast travel it calls the PlayerEntredLocationEvent event.

Database setup
Database might be confugured from the game via the commands or in file 'dbconf.json' in the plugin folder. If the file does not exist you have to do '/alocations save dbconf', it will store the default database configurations (if you had already setup the database, it will save the current datas).

Currently supported databases:

• mysql

Setting up database via the commands (ex.)
/alocations database set database mysql
/alocations database set username root
/alocations database set password 123
/alocations database set url jdbc:mysql://localhost:3306/database
/alocations database check ( Checking whether the connection is success.)
/alocations database set use yes

API
Events
Package: me.ksviety.plugins.mc.locations.events
Provided events:

• PlayerEntredLocationEvent
  Called when a player entered a location.
  Extends: PlayerEvent
  Cancellable: yes
  Provides:
  • The location that was entered by the player.
  
  
  
• PlayerLeftLocationEvent
  Extends: PlayerEvent
  Cancellable: yes
  Provides:
  • The location that was left by the player.
  
  
  
• PlayerOpenedLocationEvent
  Extends: PlayerEvent
  Cancellable: yes
  Provides:
  • The location that was opened by the player.
  
  
  
• PlayerTraveledEvent
  Extends: PlayerEvent
  Cancellable: yes
  Provides:
  • The location the player traveled to.