Interface GameObject
-
- All Superinterfaces:
Animable
,Identifiable
,Interactable
,Locatable
,LocatableEntity
,Modeled
,Renderable
,Rotatable
,Validatable
- All Known Implementing Classes:
OSRSGameObject
public interface GameObject extends LocatableEntity, Identifiable, Modeled, Animable, Rotatable
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
GameObject.Direction
static class
GameObject.Type
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default @Nullable GameObjectDefinition
getActiveDefinition()
Gets the active 'local state' of this GameObjectDefinition if present, or the base GameObjectDefinition otherwise.@Nullable GameObjectDefinition
getDefinition()
Gets the object's definition.@Nullable GameObject.Direction
getDirection()
byte
getSpecializedTypeIndicator()
Also known as getObjectModelShape.java.util.Set<java.lang.Integer>
getSpotAnimationIds()
Deprecated.useSpotAnimation
andSpotAnimations
.GameObject.Type
getType()
Gets the type of the object(e.g.-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Animable
getAnimationId
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Identifiable
getId
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Interactable
click, contains, getInteractionPoint, getInteractionPoint, getVisibility, hasDynamicBounds, hover, interact, interact, interact, interact, interact, interact, isHovered, isVisible
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Locatable
distanceTo, distanceTo, getLocalPosition
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.LocatableEntity
getArea, getArea, getHighPrecisionPosition, getHighPrecisionPosition, getPosition, getPosition
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Modeled
getModel, setBackupModel, setBackupModel, setBackupModel, setForcedModel, setForcedModel, setForcedModel
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Renderable
render, render
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Rotatable
getHighPrecisionOrientation, getOrientationAsAngle, isFacing
-
Methods inherited from interface com.runemate.game.api.hybrid.util.Validatable
isValid
-
-
-
-
Method Detail
-
getType
GameObject.Type getType()
Gets the type of the object(e.g. WallObject, FloorDecoration, etc)- Returns:
- A String representing the object type
-
getSpecializedTypeIndicator
byte getSpecializedTypeIndicator()
Also known as getObjectModelShape.0,1,2,3 = BoundaryObject 4,5,6,7,8 = WallObject 9,10,11,12,13,14,15,16,17,18,19,20,21 = PrimaryObject 22 = FloorDecoration
10 is the most common object model shape/type (standard)- Returns:
-
getDefinition
@Nullable @Nullable GameObjectDefinition getDefinition()
Gets the object's definition.- Returns:
- The object's definition or null if it's unavailable.
-
getActiveDefinition
@Nullable default @Nullable GameObjectDefinition getActiveDefinition()
Gets the active 'local state' of this GameObjectDefinition if present, or the base GameObjectDefinition otherwise.
-
getDirection
@Nullable @Nullable GameObject.Direction getDirection()
-
getSpotAnimationIds
@RS3Only @Deprecated java.util.Set<java.lang.Integer> getSpotAnimationIds()
Deprecated.useSpotAnimation
andSpotAnimations
. The implementation of this method was just a relatively accurate way of making it appear as if spot animations worked the same way for GameObjects as they do Npcs. That is not the case of the engine and this abstraction prevented several useful effects from being detected.
-
-