Package net.runelite.api
Interface Player
-
- All Superinterfaces:
Actor
,Node
,Renderable
public interface Player extends Actor
Represents a player entity in the game.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getCombatLevel()
Gets the combat level of the actor.int
getId()
Get the ID of the playerHeadIcon
getOverheadIcon()
Gets the displayed overhead icon of the player.PlayerComposition
getPlayerComposition()
Gets the composition of this player.Polygon[]
getPolygons()
Gets the polygons that make up the players model.int
getSkullIcon()
Gets the displayed skull icon of the player.int
getTeam()
Gets the current team cape team number the player is on.boolean
isClanMember()
Checks whether the player is a member of the same clan as the local player.boolean
isFriend()
Checks whether this player is a friend of the local player.boolean
isFriendsChatMember()
Checks whether this player is a member of the same friends chat the local player.void
setSkullIcon(int skullIcon)
Sets the displayed skull icon of the player.-
Methods inherited from interface net.runelite.api.Actor
clearSpotAnims, createSpotAnim, getAnimation, getAnimationFrame, getCanvasImageLocation, getCanvasSpriteLocation, getCanvasTextLocation, getCanvasTilePoly, getConvexHull, getCurrentOrientation, getGraphic, getGraphicHeight, getHealthRatio, getHealthScale, getIdlePoseAnimation, getIdleRotateLeft, getIdleRotateRight, getInteracting, getLocalLocation, getLogicalHeight, getMinimapLocation, getName, getOrientation, getOverheadCycle, getOverheadText, getPoseAnimation, getPoseAnimationFrame, getRunAnimation, getSpotAnimFrame, getSpotAnims, getWalkAnimation, getWalkRotate180, getWalkRotateLeft, getWalkRotateRight, getWorldArea, getWorldLocation, getWorldView, hasSpotAnim, isDead, isInteracting, removeSpotAnim, setActionFrame, setAnimation, setAnimationFrame, setDead, setGraphic, setGraphicHeight, setIdlePoseAnimation, setIdleRotateLeft, setIdleRotateRight, setOverheadCycle, setOverheadText, setPoseAnimation, setPoseAnimationFrame, setRunAnimation, setSpotAnimFrame, setWalkAnimation, setWalkRotate180, setWalkRotateLeft, setWalkRotateRight
-
Methods inherited from interface net.runelite.api.Node
getHash, getNext, getPrevious
-
Methods inherited from interface net.runelite.api.Renderable
getModel, getModelHeight, setModelHeight
-
-
-
-
Method Detail
-
getId
int getId()
Get the ID of the player- Returns:
-
getCombatLevel
int getCombatLevel()
Description copied from interface:Actor
Gets the combat level of the actor.- Specified by:
getCombatLevel
in interfaceActor
- Returns:
- the combat level
-
getPlayerComposition
PlayerComposition getPlayerComposition()
Gets the composition of this player.- Returns:
- the composition
-
getPolygons
Polygon[] getPolygons()
Gets the polygons that make up the players model.- Returns:
- the model polygons
-
getTeam
int getTeam()
Gets the current team cape team number the player is on.- Returns:
- team number, or 0 if not on any team
-
isFriendsChatMember
boolean isFriendsChatMember()
Checks whether this player is a member of the same friends chat the local player.- Returns:
- true if the player is a friends chat member, false otherwise
-
isFriend
boolean isFriend()
Checks whether this player is a friend of the local player.- Returns:
- true if the player is a friend, false otherwise
-
isClanMember
boolean isClanMember()
Checks whether the player is a member of the same clan as the local player.- Returns:
-
getOverheadIcon
HeadIcon getOverheadIcon()
Gets the displayed overhead icon of the player.- Returns:
- the overhead icon
-
getSkullIcon
int getSkullIcon()
Gets the displayed skull icon of the player.- Returns:
- the id skull icon, or -1 if unskulled.
- See Also:
SkullIcon
-
setSkullIcon
void setSkullIcon(int skullIcon)
Sets the displayed skull icon of the player.- Parameters:
skullIcon
- The id of the skull icon, or -1 to remove the skull icon.- See Also:
SkullIcon
-
-