API Docs for:
Show:

Component_Frame Class

Module: gs

A frame constructs a graphical frame from its skin-image. The frame can rendered by tiling or strechting the four sides of the frame. A frame is useful for creating In-Game UI windows and boxes. For more info about the skin-image format, see help-file.

Methods

dispose

()

Disposes the frame.

onDataBundleRestore.

(
  • Object
  • gs.ObjectCodecContext
)

Called if this object instance is restored from a data-bundle. It can be used re-assign event-handler, anonymous functions, etc.

Parameters:

  • Object Object

    data - The data-bundle

  • gs.ObjectCodecContext Object

    context - The codec-context.

setup

()

Setup the frame component. This method is automatically called by the system.

setupEventHandlers

()

Adds event-handlers for mouse/touch events

update

()

Updates the frame's padding, properties and skin-image.

updateImage

()

Updates the frame's skin-image used to construct the frame.

updateOptionalProperties

()

Updates the optional sprite properties from the game object properties.

updatePadding

()

Updates the padding.

updateProperties

()

Updates the frame properties from the game object properties.

Properties

frame

gs.Frame

The native frame-object.

image

String protected

The name of the skin-image used to construct the frame.