ObjectDefinition.java

/*
 * Copyright (c) 2017, Adam <Adam@sigterm.info>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.runelite.api;

/**
 * Information about a specific {@link ObjectID}
 */
public interface ObjectDefinition
{
	/**
	 * Gets ID for the object.
	 *
	 * @see ObjectID
	 */
	int getId();

	/**
	 * Gets the name of the object.
	 */
	String getName();

	/**
	 * The 5 menuops this object has when in world. Index 0 corresponds to
	 * {@link MenuAction#GAME_OBJECT_FIRST_OPTION}, Index 2 to
	 * {@link MenuAction#GAME_OBJECT_SECOND_OPTION} and so on.
	 */
	String[] getActions();

	/**
	 * Gets the index of this object in the {@link Client#getMapScene()}
	 * array, or -1 if it has no map scene icon
	 */
	int getMapSceneId();

	/**
	 * Gets the index of this object in the {@link Client#getMapIcons()}
	 * array, or -1 if it has no full map icon
	 */
	int getMapIconId();

	/**
	 * Get the {@link ObjectID}s of objects this can transform into, depending
	 * on a {@link Varbits} or {@link VarPlayer}
	 */
	int[] getImpostorIds();

	/**
	 * Get the object composition the player's state says this object should
	 * transmogrify into.
	 *
	 * @throws NullPointerException if {@link #getImpostorIds()} is null
	 */
	ObjectDefinition getImpostor();
}