[arbiter]

In order to make the Java Documentation as comprehensive as possible for our developers, we are asking for suggestions of specific classes/methods to expand upon. Just provide a brief description below and we will address it promptly.

Thanks.

 

[arbiter]

@Cloud Execution class needs specification as to which unit of time is used for delays (milliseconds) as requested by @Salvation.

 

[trigoon]

The whole API should be documented thoroughly, I have not yet seen a botting client with a flush and complete API with rich documentation.

 

[cloud]

The whole API should be documented thoroughly, I have not yet seen a botting client with a flush and complete API with rich documentation.

Although I agree, it takes a considerable amount of time to do detailed and proper documentation. I do try to add more documentation periodically however I'm aware there are sections that are still lacking. If there's ever a point that you find problematic, please comment and I'll gladly write some up.

 

[calle]

Although I agree, it takes a considerable amount of time to do detailed and proper documentation. I do try to add more documentation periodically however I'm aware there are sections that are still lacking. If there's ever a point that you find problematic, please comment and I'll gladly write some up.

asign bot authors to do it, especially the ones that are very familiar with the api

 

[cloud]

asign bot authors to do it, especially the ones that are very familiar with the api

That can't really be done in any productive way because the javadocs have to be packaged with the source code.

 

[calle]

That can't really be done in any productive way because the javadocs have to be packaged with the source code.

damn :/

 

[cloud]

Feel free to point out specific sections that you feel are under documented. Anything that's self explanatory will be gradually filled out but right now I'm most worried about things that aren't clear enough.

 

[defeat3d]

Docs need an update I think, World class doesn't exist anymore. Took me a while to find out.

 

[cloud]

Docs need an update I think, World class doesn't exist anymore. Took me a while to find out.

Updated.

 

[superbotter]

ClientUI.showAlert() could be described. It's the green notification bar on the top of the RuneMate window, right?

 

[snufalufugus]

Almost the entirety of

• com.runemate.game.api.hybrid.player_sense.PlayerSense.Key

It has literally no information for most keys besides their names.
 
Inside of "Magic" there is:
activate
public boolean activate()

For most spells this is enough, but it's not clear to authors that they can put the action into activate() to specify what to cast in the case of multiple spells being on the same icon.

 

[savior]

ItemEvents of both onItemAdded and onItemRemoved have positive values as quantityChange.
You may want to document that, since intuitively an ItemEvent's quantityChange should be negative, so that event.getType() returns REMOVAL.

 

[derk]

ItemEvents of both onItemAdded and onItemRemoved have positive values as quantityChange.
You may want to document that, since intuitively an ItemEvent's quantityChange should be negative, so that event.getType() returns REMOVAL.

To be fair it's a quantity CHANGE, and all changes of values are positive, whether you substract or add.

But your point is still valid. Document that shieeeet.

 

[savior]

all changes of values are positive, whether you substract or add

 

[snufalufugus]

SpriteItem class:

derive(int quantity) - absolutely no idea what this does...
getOrigin() - no idea...
hasDynamicBounds() - links to Interactable, where the method is also blank

Suggestions:
getIndex() - no description
"Gets the inventory slot, from 0 -> 27 numbered from left to right and top to bottom, that the spriteitem is contained by"

getBounds() - no description
"Gets the InteractableRectangle that encompasses the inventory slot containing the sprite item"
or
"Gets the InteractableRectangle that encompasses the sprite item"
depending on which it does
 
WorldHop class:
Should specify that for OSRS, you need to include the full world number. It's unintuitive since the world hop interface itself doesn't show the full world number when hopping to a new world.