CommandHelper

CommandHelper

Bukkit Plugins
46.5k Downloads

location_shift() documentation is wrong (staged api)

LadyCailinBot opened this issue ยท 2 comments

commented

CMDHELPER-3049 - Reported by Pieter12345

Current description:

  • void location_shift(location_from, location_to, distance)
  • Shift from one location to another, by defined distance.
  • Throws: InvalidWorldException, FormatException, RangeException.

Current workings:

  • locationArray location_shift(location_from, location_to, distance)
  • Returns the location, traveling the given distance from location_from to location_to. Throws a RangeException when the distance exceeds the maximum 32 bits value of an integer.
  • Throws: InvalidWorldException, FormatException, RangeException.

It does also not throw an error if location_from[world] != location_to[world] (uses location_from[world]). I'm not sure if this is intended as you can't simply remove the location_to[world] (throws an exception, world not provided).

I'm using CommandHelper 3.3.1 SNAPSHOT build 2837.

commented

Comment by PseudoKnight

I updated the docs, but I left the world issue alone since it was a doc commit. I'd recommend creating separate tickets for separate issues. It makes it easier to manage.

commented

Comment by Pieter12345

Thanks, I will create a new ticket for that issue then.