runelite-api: Add missing documentation

This commit is contained in:
Matthew Steglinski
2018-05-25 13:16:12 -04:00
committed by Adam
parent d2871d925c
commit 243d7ddbfa
155 changed files with 4190 additions and 322 deletions

View File

@@ -24,29 +24,94 @@
*/
package net.runelite.api;
/**
* Represents the template of a specific NPC type.
*/
public interface NPCComposition
{
/**
* Gets the name of the NPC.
*
* @return the name
*/
String getName();
/**
* Gets the model IDs that compose this NPC.
*
* @return the NPCs model IDs
*/
int[] getModels();
/**
* Gets an array of possible right-click menu actions that can be
* performed on the NPC.
*
* @return the menu actions
*/
String[] getActions();
/**
* Gets whether the NPC can be clicked.
*
* @return true if the NPC can be clicked, false otherwise
*/
boolean isClickable();
/**
* Gets whether the NPC is visible on the mini-map.
*
* @return the mini-map visible state
*/
boolean isMinimapVisable();
/**
* Gets whether the NPC is visible.
*
* @return the visible state
*/
boolean isVisable();
/**
* Gets the ID of the NPC.
*
* @return the ID of the NPC
* @see NpcID
*/
int getId();
/**
* Gets the combat level of the NPC.
*
* @return the combat level, -1 if none
*/
int getCombatLevel();
/**
* Gets the configuration data for the NPC.
*
* @return the configuration data
*/
int[] getConfigs();
/**
* Transforms this NPC into a new state, which may have a different ID.
*
* @return the transformed composition
*/
NPCComposition transform();
/**
* Gets the size of the NPC.
*
* @return the NPCs size
*/
int getSize();
/**
* Gets the displayed overhead icon of the NPC.
*
* @return the overhead icon
*/
HeadIcon getOverheadIcon();
}