Class CacheObjectDefinition.Extended
- java.lang.Object
-
- com.runemate.game.api.hybrid.entities.definitions.GameObjectDefinition
-
- com.runemate.game.api.hybrid.cache.elements.CacheObjectDefinition.Extended
-
- All Implemented Interfaces:
Identifiable
,Onymous
- Enclosing class:
- CacheObjectDefinition
public class CacheObjectDefinition.Extended extends GameObjectDefinition
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull java.util.List<java.lang.String>
getActions()
Gets the powers that can be performed on the object@NonNull java.util.List<java.lang.Integer>
getAnimationIds()
Gets a list of all possible animations that can be performed by this object@NonNull java.util.List<java.lang.Integer>
getAppearance()
Gets a list of integers that are used to represent this entities appearance.Attribute
getAttribute(long id)
Gets the attribute with the specified idjava.util.List<Attribute>
getAttributes()
Gets a list of all of the objects attributes.int
getClippingType()
Gets the objects clipping type, used to calculate collisionsjava.util.Map<java.awt.Color,java.awt.Color>
getColorSubstitutions()
Gets a mapping of colors that are to be substituted in the base model.int
getHeight()
Gets the objects height (in tiles)int
getId()
Gets an identifier used to identify the objectGameObjectDefinition
getLocalState()
Gets the GameObjectDefinition containing data for this objects current state (transformation).int
getMapFunction()
The circular icons that are displayed on the map and minimap as an indicatorint
getMapScene()
Object icons that are rendered on the map and minimap such as trees, rocks, bushes, etc.java.util.Map<Material,Material>
getMaterialSubstitutions()
Gets a mapping of materials that are to be substituted in the base model.int[][]
getModelIds()
int[]
getModelTypes()
int
getModelXScale()
int
getModelXTranslation()
int
getModelYScale()
int
getModelYTranslation()
int
getModelZScale()
int
getModelZTranslation()
@NonNull java.lang.String
getName()
java.lang.String[]
getRawActions()
Varbit
getStateVarbit()
TheVarbit
responsible for controlling the state (GameObjectDefinition) of the GameObject, if present.Varp
getStateVarp()
TheVarp
responsible for controlling the state (GameObjectDefinition) of the GameObject, if present.@NonNull java.util.Collection<GameObjectDefinition>
getTransformations()
Gets all the possible transformations for the given game object.int
getWidth()
Gets the objects width (in tiles)boolean
impassable()
A flag that is used to determine whether or not certain objects can be walked on.boolean
impenetrable()
Determines whether or not projectiles can bypass/go through the object to reach their targetsboolean
isInteractable()
boolean
isModelMirrorable()
int[]
transformationIds()
-
-
-
Method Detail
-
getLocalState
public final GameObjectDefinition getLocalState()
Description copied from class:GameObjectDefinition
Gets the GameObjectDefinition containing data for this objects current state (transformation). For example, in farming the patch id doesn't change when your player plants something in it, however it's local state does. This GameObjectDefinition contains information such as a plant specific id, the plants specific name, and the available powers.- Specified by:
getLocalState
in classGameObjectDefinition
- Returns:
- a GameObjectDefinition if the objects state changes locally, otherwise null
-
getTransformations
@NonNull public @NonNull java.util.Collection<GameObjectDefinition> getTransformations()
Description copied from class:GameObjectDefinition
Gets all the possible transformations for the given game object. Objects can transform based on various in game events such as activating a lodestone.- Specified by:
getTransformations
in classGameObjectDefinition
- Returns:
- a non-null Collection of all possible transformations.
-
getActions
@NonNull public @NonNull java.util.List<java.lang.String> getActions()
Description copied from class:GameObjectDefinition
Gets the powers that can be performed on the object- Specified by:
getActions
in classGameObjectDefinition
-
getRawActions
public java.lang.String[] getRawActions()
- Specified by:
getRawActions
in classGameObjectDefinition
-
getAnimationIds
@NonNull public @NonNull java.util.List<java.lang.Integer> getAnimationIds()
Description copied from class:GameObjectDefinition
Gets a list of all possible animations that can be performed by this object- Specified by:
getAnimationIds
in classGameObjectDefinition
-
getAppearance
@NonNull public @NonNull java.util.List<java.lang.Integer> getAppearance()
Description copied from class:GameObjectDefinition
Gets a list of integers that are used to represent this entities appearance. Internally these are used to generate a GameObject's Model.- Specified by:
getAppearance
in classGameObjectDefinition
-
transformationIds
public int[] transformationIds()
-
getClippingType
public int getClippingType()
Description copied from class:GameObjectDefinition
Gets the objects clipping type, used to calculate collisions- Specified by:
getClippingType
in classGameObjectDefinition
-
getWidth
public int getWidth()
Description copied from class:GameObjectDefinition
Gets the objects width (in tiles)- Specified by:
getWidth
in classGameObjectDefinition
-
getHeight
public int getHeight()
Description copied from class:GameObjectDefinition
Gets the objects height (in tiles)- Specified by:
getHeight
in classGameObjectDefinition
-
impassable
public boolean impassable()
Description copied from class:GameObjectDefinition
A flag that is used to determine whether or not certain objects can be walked on. Its main purpose is for path generation.- Specified by:
impassable
in classGameObjectDefinition
-
getAttribute
public Attribute getAttribute(long id)
Description copied from class:GameObjectDefinition
Gets the attribute with the specified id- Specified by:
getAttribute
in classGameObjectDefinition
- Returns:
- the attribute if available, otherwise null
-
getAttributes
public java.util.List<Attribute> getAttributes()
Description copied from class:GameObjectDefinition
Gets a list of all of the objects attributes.- Specified by:
getAttributes
in classGameObjectDefinition
-
getColorSubstitutions
public java.util.Map<java.awt.Color,java.awt.Color> getColorSubstitutions()
Description copied from class:GameObjectDefinition
Gets a mapping of colors that are to be substituted in the base model.- Specified by:
getColorSubstitutions
in classGameObjectDefinition
-
getMaterialSubstitutions
public java.util.Map<Material,Material> getMaterialSubstitutions()
Description copied from class:GameObjectDefinition
Gets a mapping of materials that are to be substituted in the base model.- Specified by:
getMaterialSubstitutions
in classGameObjectDefinition
-
getId
public int getId()
Description copied from class:GameObjectDefinition
Gets an identifier used to identify the object- Specified by:
getId
in interfaceIdentifiable
- Specified by:
getId
in classGameObjectDefinition
-
getMapFunction
public int getMapFunction()
Description copied from class:GameObjectDefinition
The circular icons that are displayed on the map and minimap as an indicator- Specified by:
getMapFunction
in classGameObjectDefinition
-
getMapScene
public int getMapScene()
Description copied from class:GameObjectDefinition
Object icons that are rendered on the map and minimap such as trees, rocks, bushes, etc.- Specified by:
getMapScene
in classGameObjectDefinition
-
getName
@NonNull public @NonNull java.lang.String getName()
- Specified by:
getName
in interfaceOnymous
- Specified by:
getName
in classGameObjectDefinition
-
getModelIds
public int[][] getModelIds()
-
getModelTypes
public int[] getModelTypes()
- Specified by:
getModelTypes
in classGameObjectDefinition
-
impenetrable
public boolean impenetrable()
Description copied from class:GameObjectDefinition
Determines whether or not projectiles can bypass/go through the object to reach their targets- Specified by:
impenetrable
in classGameObjectDefinition
- Returns:
-
getModelXScale
public int getModelXScale()
- Specified by:
getModelXScale
in classGameObjectDefinition
-
getModelYScale
public int getModelYScale()
- Specified by:
getModelYScale
in classGameObjectDefinition
-
getModelZScale
public int getModelZScale()
- Specified by:
getModelZScale
in classGameObjectDefinition
-
getModelXTranslation
public int getModelXTranslation()
- Specified by:
getModelXTranslation
in classGameObjectDefinition
-
getModelYTranslation
public int getModelYTranslation()
- Specified by:
getModelYTranslation
in classGameObjectDefinition
-
getModelZTranslation
public int getModelZTranslation()
- Specified by:
getModelZTranslation
in classGameObjectDefinition
-
isModelMirrorable
public boolean isModelMirrorable()
- Specified by:
isModelMirrorable
in classGameObjectDefinition
-
isInteractable
public boolean isInteractable()
- Specified by:
isInteractable
in classGameObjectDefinition
-
getStateVarp
public Varp getStateVarp()
Description copied from class:GameObjectDefinition
TheVarp
responsible for controlling the state (GameObjectDefinition) of the GameObject, if present.- Specified by:
getStateVarp
in classGameObjectDefinition
-
getStateVarbit
public Varbit getStateVarbit()
Description copied from class:GameObjectDefinition
TheVarbit
responsible for controlling the state (GameObjectDefinition) of the GameObject, if present.- Specified by:
getStateVarbit
in classGameObjectDefinition
-
-