JSDoc: Global

Summary

Classes

Button: Simple button element
CanvasContext: Custom Canvas context
Circle: Circle or ellipse shaped tectured object
CoverNode: Object that covers whole viewport area and lives outside the scene.
Director: Director object. Base object for every game.
GlossyButton: Glossy button. Rounded button with some predefined style. Use lime.Button for lower level control.
Label: Display object for text
Layer: Layer object. This object has no visible body itself but acts as a container for other objects. Setting position/scale etc changes position/scale of all of its children
Node: Node. Abstract drawable object in lime.
Polygon: Polygon shaped textured object
Renderer: Renderer logic object. This object defines lower level technologies that are used to draw Node instaces on screen.
RoundedRect: Rounded rectangle
Scene: Scene object
Sprite: Rectangural textured object
SpriteSheet: Sprite Sheets allows you to gather your image assets to the same image file and define frames that contains the needed keyframe animations, multiple formats are supported.
Animation: General object for running animations on nodes
ColorTo: Animation for changing element's fillcolor value
Delay: No-op animation. Useful for making pauses on sequence animations.
FadeTo: Animation for changing elements opacity value
KeyframeAnimation: Keyframe Animation object. Keyframe Animation contains images that are changed on targets. Similar to GIF effect.
Loop: Loop animation again after it has finished
MoveBy: Move elemenet by offset Also accepts two numbers (x and y)
MoveTo: Move element to specific position Also accepts two numbers (x and y)
Resize: Resize element
RotateBy: Rotate by given angle in degrees
RotateTo: Rotate to given angle in degrees
ScaleBy: Scale by a factor Also accepts one or two numbers
ScaleTo: Scale to a given factor Also accepts one or two numbers
Sequence: Sequence of animations that are run after each other. Also accepts more than two animations
Spawn: Animations that are run parallel with each other. Also accepts more than two animations
actionManager: ActionManager. Doesn't let animations that modify same parameters run together on same targets.
Audio: Audio stream object
AudioMap: AudioMap object
Drag: Object representing Drag interaction.
Event: Dfkit Event object
EventDispatcher: EventDispatcher object. Deals with event handlers
Color: Color fill
Fill: Abstract class for adding textures to sprites
Frame: Image fill.
Image: Image fill.
LinearGradient: Linear gradient fill.
Stroke: Stroke
PauseScene: PauseScene. This scene appears when director is paused.
scheduleManager: Unified timer provider class Don't create instances of this class. Used the shared instance.
Task: Scheduled task
Transform: Object representing CSS Transform.
Dissolve: Dissolve transition
MoveInDown
MoveInLeft: Move-In transition. Difference form slide-in is that outgoing scene does not move.
MoveInRight
MoveInUp
SlideIn: Slide-In transition.
SlideInDown
SlideInRight
SlideInUp
Transition: Animation for switching active scenes
Container
Scroller
TempCtor
StringBuilder: Utility class to facilitate much faster string concatenation in IE, using Array.join() rather than the '+' operator. For other browsers we simply use the '+' operator.
InstantiableCtor
SanitizedCss: Content of type soydata.SanitizedContentKind.CSS. The content is non-attacker-exploitable CSS, such as {@code color:#c3d9ff}.
SanitizedHtml: Content of type soydata.SanitizedContentKind.HTML. The content is a string of HTML that can safely be embedded in a PCDATA context in your app. If you would be surprised to find that an HTML sanitizer produced {@code s} (e.g. it runs code or fetches bad URLs) and you wouldn't write a template that produces {@code s} on security or privacy grounds, then don't pass {@code s} here.
SanitizedHtmlAttribute: Content of type soydata.SanitizedContentKind.ATTRIBUTES. The content should be safely embeddable within an open tag, such as a key="value" pair.
SanitizedJs: Content of type soydata.SanitizedContentKind.JS. The content is Javascript source that when evaluated does not execute any attacker-controlled scripts.
SanitizedJsStrChars: Content of type soydata.SanitizedContentKind.JS_STR_CHARS. The content can be safely inserted as part of a single- or double-quoted string without terminating the string.
SanitizedUri: Content of type soydata.SanitizedContentKind.URI. The content is a URI chunk that the caller knows is safe to emit in a template.
UnsanitizedText: Unsanitized plain text string. While all strings are effectively safe to use as a plain text, there are no guarantees about safety in any other context such as HTML. This is sometimes used to mark that should never be used unescaped.