Noble Engine

Noble.Transition

An abstract class from which transition types are extended.

---

Functions

Noble.Transition.setDefaultProperties(__transition, __properties)

Use this to modify multiple default properties of a transition. Having default properties avoids having to set them every time a transition is called. Properties added here are merged with the existing default properties table. Overwrites only happen when a new value is set.

Parameters

• __transition
  
• __properties
  

See

Noble.Transition.defaultProperties

Usage

Noble.Transition.setDefaultProperties(Noble.Transition.CrossDissolve, {
	dither = Graphics.image.kDitherTypeDiagonalLine
	ease = Ease.outQuint
})
Noble.Transition.setDefaultProperties(Noble.Transition.SpotlightMask, {
	x = 325,
	y = 95,
	invert = true
})

Noble.Transition:setProperties(__arguments)

Do not call this directly. Implement this in a custom transition in order to set properties from user arguments given in Noble.transition(). See existing transitions for implementation examples.

Parameters

• __arguments
  

See

Noble.transition

Noble.Transition:onStart()

Do not call this directly. Implement this in a custom transition in order to run custom code when the transition starts. Default transitions in Noble Engine do not use this.

Noble.Transition:onMidpoint()

Do not call this directly. Implement this in a custom transition in order to run custom code when the transition reaches its midpoint. Default transitions in Noble Engine do not use this.

Noble.Transition:onHoldTimeElapsed()

Do not call this directly. Implement this in a custom transition in order to run custom code when the transition's hold time has elapsed. Default transitions in Noble Engine do not use this.

Noble.Transition:onComplete()

Do not call this directly. Implement this in a custom transition in order to run custom code when the transition completes. Default transitions in Noble Engine do not use this.

Noble.Transition:draw()

Do not call this directly. Implement this in a custom transition to draw the transition. This runs once per frame while the transition is running. See existing transitions for implementation examples.

Tables

Noble.Transition.defaultProperties

A transition may have unique properties that can be set by the user when invoked. This table holds the default values for those properties.

See

Noble.Transition.setDefaultProperties

Fields

Noble.Transition.Type.CUT

A transition type where no time at all passes between scenes.

See

Noble.Transition.Type.COVER

A transition type that has an "Enter" phase and an "Exit" phase. The new scene does not become active until the Enter phase is complete. A "holdTime" value determines how long to wait after the Enter phase completes before starting the Exit phase.

See

Noble.Transition.Type.MIX

A transition type that takes a screenshot of the exiting scene and activates the new scene before beginning the transition, allowing for both scenes to appear to be visible during the transition.

See

Noble.Transition.CrossDissolve

Noble.Transition.CrossDissolve.defaultProperties

A simple cross-fade.

Fields

• ease Ease = Ease.outCubic (default)
  
• dither Graphics.image.kDither = Graphics.image.kDitherTypeBayer4x4 (default)
  

Noble.Transition.Cut

Noble.Transition.Cut.defaultProperties

An all-time classic. This transition has no properties.

Noble.Transition.Dip

Noble.Transition.Dip.defaultProperties

Fade to an image, then to the next scene.

Fields

• holdTime number = 0.25 (default)
  
• panelImage Graphics.image
  
• dither Graphics.image.kDither = Graphics.image.kDitherTypeBayer4x4 (default)
  
• ease Ease = Ease.outInQuad (default)
  
• x number = 0 (default)
  
• y number = 0 (default)
  

Noble.Transition.DipToBlack

Noble.Transition.DipToBlack.defaultProperties

Fade to black, then to the next scene. NOTE: The panelImage property is locked.

See

Noble.Transition.Dip.defaultProperties

Noble.Transition.DipToWhite

Noble.Transition.DipToWhite.defaultProperties

Fade to white, then to the next scene. NOTE: The panelImage property is locked.

See

Noble.Transition.Dip.defaultProperties

Noble.Transition.Imagetable

Noble.Transition.Imagetable.defaultProperties

A dip-style transition using one or two imagetables.

Fields

• holdTime number = 0 (default)
  
• imagetable Graphics.imagetable
  
• reverse boolean = false (default)
  
• flipX boolean = false (default)
  
• flipY boolean = false (default)
  
• rotate boolean = false (default)
  
• imagetableEnter Graphics.imagetable
  
• reverseEnter boolean = nil (default)
  
• flipXEnter boolean = nil (default)
  
• flipYEnter boolean = nil (default)
  
• rotateEnter boolean = nil (default)
  
• imagetableExit Graphics.imagetable
  
• reverseExit boolean = nil (default)
  
• flipXExit boolean = nil (default)
  
• flipYExit boolean = nil (default)
  
• rotateExit boolean = nil (default)
  

See

Noble.Transition.ImagetableMask.defaultProperties

Noble.Transition.ImagetableMask

Noble.Transition.ImagetableMask.defaultProperties

A wipe transition using an animated mask in the form of an imagetable.

Fields

• imagetable Graphics.imagetable
  
• reverse boolean = false (default)
  Set true to play the imagetable's frames in reverse order.
• flipX boolean = false (default)
  
• flipY boolean = false (default)
  
• rotate boolean = false (default)
  Set as true to rotate the image 180-degrees
• hasTransparency boolean = true (default)
  Set as true if the imagetable asset has transparent pixels. Set as false if the image uses white pixels for transparency.
• invert boolean = false (default)
  Set as true to invert the image mask.

See

Noble.Transition.Imagetable.defaultProperties

Noble.Transition.MetroNexus

Noble.Transition.MetroNexus.defaultProperties

A "cascade" wipe transition, taken from "Metro Nexus" by Noble Robot. This transition has no properties.

Noble.Transition.SlideOff

Noble.Transition.SlideOff.defaultProperties

The previous scene slides off the screen, revealing the next scene.

Fields

• ease Ease = Ease.outInQuad (default)
  
• x number = 0 (default)
  
• y number = 0 (default)
  
• rotation number = 0 (default)
  

Noble.Transition.SlideOffDown

Noble.Transition.SlideOffDown.defaultProperties

The previous scene slides off the bottom of the screen, revealing the next scene. NOTE: The x, y, and rotation properties are locked.

See

Noble.Transition.SlideOff.defaultProperties

Noble.Transition.SlideOffLeft

Noble.Transition.SlideOffLeft.defaultProperties

The previous scene slides off the left side of the screen, revealing the next scene. NOTE: The x, y, and rotation properties are locked.

See

Noble.Transition.SlideOff.defaultProperties

Noble.Transition.SlideOffRight

Noble.Transition.SlideOffRight.defaultProperties

The previous scene slides off the right side of the screen, revealing the next scene. NOTE: The x, y, and rotation properties are locked.

See

Noble.Transition.SlideOff.defaultProperties

Noble.Transition.SlideOffUp

Noble.Transition.SlideOffUp.defaultProperties

The previous scene slides off the top of the screen, revealing the next scene. NOTE: The x, y, and rotation properties are locked.

See

Noble.Transition.SlideOff.defaultProperties

Noble.Transition.SlideOn

Noble.Transition.SlideOn.defaultProperties

The next scene slides on the screen, covering up the previous scene.

Fields

• ease Ease = Ease.outInQuad (default)
  
• x number = 0 (default)
  
• y number = 0 (default)
  
• rotation number = 0 (default)
  

Noble.Transition.SlideOnDown

Noble.Transition.SlideOnDown.defaultProperties

The next scene slides onto the screen from the top, covering up the previous scene. NOTE: The x, y, and rotation properties are locked.

See

Noble.Transition.SlideOn.defaultProperties

Noble.Transition.SlideOnLeft

Noble.Transition.SlideOnLeft.defaultProperties

The next scene slides onto the screen right-to-left, covering up the previous scene. NOTE: The x, y, and rotation properties are locked.

See

Noble.Transition.SlideOn.defaultProperties

Noble.Transition.SlideOnRight

Noble.Transition.SlideOnRight.defaultProperties

The next scene slides onto the screen left-to-right, covering up the previous scene. NOTE: The x, y, and rotation properties are locked.

See

Noble.Transition.SlideOn.defaultProperties

Noble.Transition.SlideOnUp

Noble.Transition.SlideOnUp.defaultProperties

The next scene slides onto the screen from the bottom, covering up the previous scene. NOTE: The x, y, and rotation properties are locked.

See

Noble.Transition.SlideOn.defaultProperties

Noble.Transition.Spotlight

Noble.Transition.Spotlight.defaultProperties

A spotlight in-out transition.

Fields

• holdTime number = 0.25 (default)
  
• panelImage Graphics.image
  
• dither Graphics.image.kDither = Graphics.image.kDitherTypeBayer4x4 (default)
  
• ease Ease = Ease.outInQuad (default)
  
• x number = 200 (default)
  
• y number = 120 (default)
  
• easeEnter Ease = nil (default)
  
• xEnter number = nil (default)
  
• yEnter number = nil (default)
  
• xEnterStart number = nil (default)
  
• yEnterStart number = nil (default)
  
• xEnterEnd number = nil (default)
  
• yEnterEnd number = nil (default)
  
• easeEnter Ease = nil (default)
  
• xExit number = nil (default)
  
• yExit number = nil (default)
  
• xExitStart number = nil (default)
  
• yExitStart number = nil (default)
  
• xExitEnd number = nil (default)
  
• yExitEnd number = nil (default)
  

See

Noble.Transition.SpotlightMask.defaultProperties

Noble.Transition.SpotlightMask

Noble.Transition.SpotlightMask.defaultProperties

A circle wipe transition.

Fields

• ease Ease = Ease.outQuad (default)
  
• x number = 200 (default)
  
• y number = 120 (default)
  
• xStart number = nil (default)
  
• yStart number = nil (default)
  
• xEnd number = nil (default)
  
• yEnd number = nil (default)
  
• invert boolean = false (default)
  

See

Noble.Transition.Spotlight.defaultProperties

Noble.Transition.WidgetSatchel

Noble.Transition.MetroNexus.defaultProperties

An "accordion" transition, taken from "Widget Satchel" by Noble Robot. This transition has no properties.