/CHPlotMe

Extension for PlotMe functionality in CommandHelper

Primary LanguageJavaMIT LicenseMIT

###Table of Contents###

###General Functions###

plot_owner(@world, [@id][id]) - Get the owner of a given plot.

Returns: player name.


plot_list(@world) - Get a list of all the known plot ids for a given world.

Returns: array of [@id][id]


plotid_at_loc(@location) - Get a plot's id for a given location.

Returns: [@id][id]


plot_info(@world, [@id][id]) - Return an array of information for a given plot id.

Returns: [@plotinfo][pinfo]


set_plot_info(@world, [@id][id], @array) - Sets information for a given plot id.

Almost anything returned by plot_info can be modified. Experimental!

Returns: void


plot_world_info(@world) - Return an array of information for a given world.

Returns: [@plotworldinfo][pwinfo]


player_plots(@world, @player) - Return an array of plots player owns in world.

Returns: array of [@ids][id]


###Glossary###

  • id - String - The id of a plot, in format x;y. [id]: #id

  • plotinfo - Assoc. Array - Information about a given plot:

    • id - String - [@id][id]
    • world - String - World this plot resides on.
    • owner - String - Owning player's name.
    • allowed - Array of String - List of player names allowed to build on this plot, besides the owner.
    • denied - Array of String - List of player names not allowed to build on this plot.
    • biome - String - Biome type for this plot.
    • finished - Boolean - If this plot is flagged as finished.
    • finisheddate - String - Date the plot was finished on.
    • forsale - Boolean - If this plot is for sale.
    • currentbidder - String - Playername of current bidder for this plot.
    • currentbid - Integer - Current bidder's bid.
    • customprice - Integer - Price for plot.
    • protect - Boolean - Whether this plot is protected. [pinfo]: #pinfo
  • plotworldinfo - Assoc. Array - Information about a world:

    • plotsize - Integer - Dimention of plots.
    • pathwidth - Integer - Width of paths between plots.
    • plots - Array of String - Plot [@ids][id] for plots in this world. [pwinfo]: #pwinfo