CameraFocusableEntity

Group
player
Methods
3
Fields
None

Getting one

client:getCameraFocusEntity()

Methods

MethodReturnsDescription
getCameraFocus()LocalPointThe centre of the tile the camera follows, in the local units of the world view holding the tile (a boat's, for a tile on it): its `LocalPo…
getWorldView()WorldViewThe top level, whichever world view holds the tile.
equals(any)booleanWhether other equals this CameraFocusableEntity, as == answers it (false for a value of another class).

Returned by

MethodReturnsDescription
Client.getCameraFocusEntityCameraFocusableEntity?What the camera follows: the Player or NPC (the handle every other read of it gives, so == against getLocalPlayer() holds), the `Wo…

Method details

getCameraFocus

getCameraFocus: (CameraFocusableEntity) -> LocalPoint

The centre of the tile the camera follows, in the local units of the world view holding the tile (a boat's, for a tile on it): its LocalPoint names the top level (0) whichever view that is. Read when asked, as the client sets its one coordinate entity at each camera update, so a kept object follows the camera's tile; once the camera follows something else, the last tile read.

equals

equals: (CameraFocusableEntity, any) -> boolean

Whether other equals this CameraFocusableEntity, as == answers it (false for a value of another class).