unicodetiles.js

ut.Tile = function( ch, r, g, b, br, bg, bb )

Constructs a new Tile object.

Parameters

ut.Tile.prototype.getChar = function()

Returns the character of this tile.

ut.Tile.prototype.setChar = function( ch )

Sets the character of this tile.

ut.Tile.prototype.setColor = function( r, g, b )

Sets the foreground color of this tile.

ut.Tile.prototype.setGrey = function( grey )

Sets the foreground color to the given shade (0-255) of grey.

ut.Tile.prototype.setBackground = function( r, g, b )

Sets the background color of this tile.

ut.Tile.prototype.resetColor = function()

Clears the color of this tile / assigns default color.

ut.Tile.prototype.resetBackground = function()

Clears the background color of this tile.

ut.Tile.prototype.getColorHex = function()

Returns the hexadecimal representation of the color

ut.Tile.prototype.getBackgroundHex = function()

Returns the hexadecimal representation of the background color

ut.Tile.prototype.getColorRGB = function()

Returns the CSS rgb(r,g,b) representation of the color

ut.Tile.prototype.getBackgroundRGB = function()

Returns the CSS rgb(r,g,b) representation of the background color

ut.Tile.prototype.getColorJSON = function()

Returns the JSON representation of the color, i.e. object { r, g, b }

ut.Tile.prototype.getBackgroundJSON = function()

Returns the JSON representation of the background color, i.e. object { r, g, b }

ut.Tile.prototype.copy = function( other )

Makes this tile identical to the one supplied.  Custom properties are not copied.

ut.Tile.prototype.clone = function()

Returns a new copy of this tile.  Custom properties are not cloned.

ut.Viewport = function( elem, w, h, renderer, squarify )

Constructs a new Viewport object.  If you wish to display a player character at the center, you should use odd sizes.

Parameters

this.updateStyle = function( updateRenderer )

If the style of the parent element is modified, this needs to be called.

this.setRenderer = function( newrenderer )

Switch renderer at runtime.  All methods fallback to “dom” if unsuccesful.  Possible values:

• ”webgl” - Use WebGL with an HTML5 <canvas> element
• ”canvas” - Use HTML5 <canvas> element
• ”dom” - Use regular HTML element manipulation through DOM
• ”auto” - Use best available, i.e. try the above in order, picking the first that works

ut.Viewport.prototype.getRendererString = function()

Gets the currently used renderer.

Returns

One of “webgl”, “canvas”, “dom”, “”.

ut.Viewport.prototype.put = function( tile, x, y )

Puts a tile to the given coordinates.  Checks bounds and does nothing if invalid coordinates are given.

Parameters

ut.Viewport.prototype.unsafePut = function( tile, x, y )

Puts a tile to the given coordinates.  Does not check bounds; throws exception if invalid coordinates are given.

Parameters

ut.Viewport.prototype.putString = function( str, x, y, r, g, b, br, bg, bb )

Creates a row of tiles with the chars of the given string.  Wraps to next line if it can’t fit the chars on one line.

Parameters

ut.Viewport.prototype.get = function( x, y )

Returns the tile in the given coordinates.  Checks bounds and returns empty tile if invalid coordinates are given.

Parameters

Returns

The tile.

ut.Viewport.prototype.clear = function()

Clears the viewport buffer by assigning empty tiles.

ut.Viewport.prototype.render = function()

Renders the buffer as html to the element specified at construction.

ut.Engine = function( vp, func, w, h )

Constructs a new Engine object.  If width or height is given, it will not attempt to fetch tiles outside the boundaries.  In that case 0,0 is assumed as the upper-left corner of the world, but if no width/height is given also negative coords are valid.

Parameters

ut.Engine.prototype.setTileFunc = function( func, effect, duration )

Sets the function to be called with coordinates to fetch each tile.  Optionally can apply a transition effect.  Effects are: “boxin”, “boxout”, “circlein”, “circleout”, “random”

Parameters

ut.Engine.prototype.setMaskFunc = function( func )

Sets the function to be called to fetch mask information according to coordinates.  If mask function returns false to some coordinates, then that tile is not rendered.

Parameters

ut.Engine.prototype.setShaderFunc = function( func )

Sets the function to be called to post-process / shade each visible tile.  Shader function is called even if caching is enabled, see Engine.setCacheEnabled.

Parameters

ut.Engine.prototype.setWorldSize = function( width, height )

Tiles outside of the range x = [0,width[; y = [0,height[ are not fetched.  Set to undefined in order to make the world infinite.

Parameters

ut.Engine.prototype.setCacheEnabled = function( mode )

Enables or disables the usage of tile cache.  This means that extra measures are taken to not call the tile function unnecessarily.  This means that all animating must be done in a shader function, see Engine.setShaderFunc.  Cache is off by default, but should be enabled if the tile function does more computation than a simple array look-up.

Parameters

ut.Engine.prototype.update = function( x, y )

Updates the viewport according to the given player coordinates.  The algorithm goes as follows:

• Record the current time
• For each viewport tile:
• Check if the tile is visible by testing the mask
• If not visible, continue to the next tile in the viewport
• Otherwise, if cache is enabled try to fetch the tile from there
• Otherwise, call the tile function and check for shader function presence
• If there is shader function, apply it to the tile, passing the recorded time
• Put the tile to viewport

Parameters