getNpc
getNpc: (HighlightedNpc) -> NPCThe NPC.
HighlightedNpc.builder():build()| Method | Returns | Description |
|---|---|---|
getNpc() | NPC | The NPC. |
getHighlightColor() | Color | The border (and name) colour. |
getFillColor() | Color | The fill colour. |
isHull() | boolean | Draw the model's convex hull. |
isTile() | boolean | Draw the tiles under the NPC where it is drawn. |
isTrueTile() | boolean | Draw the tiles it occupies on the server. |
isSwTile() | boolean | Draw its south-west tile where it is drawn. |
isSwTrueTile() | boolean | Draw its south-west tile on the server. |
isOutline() | boolean | Draw a model outline. |
isName() | boolean | Draw its name above it. |
isNameOnMinimap() | boolean | Draw its name on the minimap. |
getBorderWidth() | number | The border (and outline) width. |
getOutlineFeather() | number | The outline's feather, 0-4. |
getRender() | ((NPC) -> boolean)? | The per-frame predicate deciding whether to draw it, if any. |
equals(any) | boolean | Equal when every field is equal. |
toString() | string | HighlightedNpc(npc=…, …). |
builder() | HighlightedNpcBuilder | A builder with every field at its default. |
| Method | Returns | Description |
|---|---|---|
HighlightedNpcBuilder.build | HighlightedNpc | The HighlightedNpc; raises when npc or highlightColor is unset. |
getNpcgetNpc: (HighlightedNpc) -> NPCThe NPC.
getHighlightColorgetHighlightColor: (HighlightedNpc) -> ColorThe border (and name) colour.
getFillColorgetFillColor: (HighlightedNpc) -> ColorThe fill colour.
isHullisHull: (HighlightedNpc) -> booleanDraw the model's convex hull.
isTileisTile: (HighlightedNpc) -> booleanDraw the tiles under the NPC where it is drawn.
isTrueTileisTrueTile: (HighlightedNpc) -> booleanDraw the tiles it occupies on the server.
isSwTileisSwTile: (HighlightedNpc) -> booleanDraw its south-west tile where it is drawn.
isSwTrueTileisSwTrueTile: (HighlightedNpc) -> booleanDraw its south-west tile on the server.
isOutlineisOutline: (HighlightedNpc) -> booleanDraw a model outline.
isNameisName: (HighlightedNpc) -> booleanDraw its name above it.
isNameOnMinimapisNameOnMinimap: (HighlightedNpc) -> booleanDraw its name on the minimap.
getBorderWidthgetBorderWidth: (HighlightedNpc) -> numberThe border (and outline) width.
getOutlineFeathergetOutlineFeather: (HighlightedNpc) -> numberThe outline's feather, 0-4.
getRendergetRender: (HighlightedNpc) -> ((NPC) -> boolean)?The per-frame predicate deciding whether to draw it, if any.
equalsequals: (HighlightedNpc, any) -> booleanEqual when every field is equal.
toStringtoString: (HighlightedNpc) -> stringHighlightedNpc(npc=…, …).
builderbuilder: () -> HighlightedNpcBuilderA builder with every field at its default.