Back to isometric documentation.
The isometric engine provides a generic view for displaying dynamic (moving) items on the grid.
See grid settings for details on how to setup a layer for displaying dynamic items.
The ItemView class is located in isometric.views.item.ItemView.
Whenever a dynamic item is created the engine check if the item is visible. If the item is visible and there's no view attached then a new view is obtained and attached to the model. When the item moves of screen then the item breaks the link between the model and the view and release the view.
The itemSettings data structure is an object, each key in the object contains a configuration for
displaying an item.
width {number}---The width of the view.height {number}---The height of the view.color {string}---Optional, The background color of the view.x {number}---The relative x position of the view in relation the the item position.y {number}---The relative y position of the view in relation the the item position.images {array}---A list of images which can be displayed, if images are set then the color is ignored.
The DynamicModel class is the base class for all items which don't have a fixed position on the grid.
Parameters:
tileX {number} = 0---Optional, the x-position of the item.tileY {number} = 0---Optional, the y-position of the item.x {numner} = 0.5---Optional, the x-position of the item within the tile in the range of 0..1.y {numner} = 0.5---Optional, the y-position of the item within the tile in the range of 0..1.
getOpts()
Get the options which contain the current settings of the item.
Returns {object} ---Returns the opts.
setPos(x, y)
Set the position of the item within the tile, valid values are in the range of 0..1.
Parameters
x {number}---The x-position within the tile.y {number}---The y-position within the tile.
setPath(path)
Set a path to walk, the path is a list of objects with tileX and tileY values.
Parameters
path {array}---A list of objects containing atileXandtileYproperty.
getTileX()
Get the x-position.
Returns {number} ---The x-position.
getTileY()
Get the y-position.
Returns {number} ---The y-position.
moveTo(destTileX, destTileY, x, y)
Searches a path. The searching is done asynchronous so for long distances it might take a while.
Parameters
destTileX---Which x-position to move to.destTileY---Which y-position to move to.x---Which x-position to move to within the tile.y---Which y-position to move to within the tile.
onNewTile()
This function can be implemented in subclasses and is called whenever the item moves from one tile to another -as opposed to moving within a tile-.
tick(dt)
This function is called once every frame.
Parameters
dt {number}---The number of milliseconds elapsed since the last invocation.
needsSleep()
When this function is called the link between the model is broken and the tick function will no longer be called on the model.
The model remains in a list and can be woken up with the wakeupModel in the ModelViewConnector class.
needsRemove()
When this function is called the link between the model is broken and the model will be completely removed.
If you subclass the DynamicModel class then there are several private variables which you can change to
modify the behaviour of this class, there are also a number of variables which to can read to asses the state
of the model.
_this.zIndex
_zIndex {number} = 0---This value is added to the calculated z-index.
_this.roadLeft
_roadLeft {number} = 0.2---This is the offset at which the items moves.
_this.roadRight
_roadRight {number} = 0.8---This is the offset at which ite item moves on the other side of the road.
_this.movedX
_movedX {number}---When moving left this value is -1, when moving right this value = 1 else this value = 0.
_this.movedY
_movedY {number}---When moving uo this value is -1, when moving down this value = 1 else this value = 0.
_this.onScreen
_onScreen {boolean}---This value is true when the item is visible.
Back to isometric documentation.