HighlightedNpc

Methods
17
Fields
None

Getting one

HighlightedNpc.builder():build()

Methods

MethodReturnsDescription
getNpc()NPCThe NPC.
getHighlightColor()ColorThe border (and name) colour.
getFillColor()ColorThe fill colour.
isHull()booleanDraw the model's convex hull.
isTile()booleanDraw the tiles under the NPC where it is drawn.
isTrueTile()booleanDraw the tiles it occupies on the server.
isSwTile()booleanDraw its south-west tile where it is drawn.
isSwTrueTile()booleanDraw its south-west tile on the server.
isOutline()booleanDraw a model outline.
isName()booleanDraw its name above it.
isNameOnMinimap()booleanDraw its name on the minimap.
getBorderWidth()numberThe border (and outline) width.
getOutlineFeather()numberThe outline's feather, 0-4.
getRender()((NPC) -> boolean)?The per-frame predicate deciding whether to draw it, if any.
equals(any)booleanEqual when every field is equal.
toString()stringHighlightedNpc(npc=…, …).
builder()HighlightedNpcBuilderA builder with every field at its default.

Returned by

MethodReturnsDescription
HighlightedNpcBuilder.buildHighlightedNpcThe HighlightedNpc; raises when npc or highlightColor is unset.

Method details