Packageverlocity.settings
Classpublic class SettingsData
InheritanceSettingsData Inheritance Object

This class holds all the settings data. If you do not override them, they will default to these.


Public Properties
 PropertyDefined By
  BGCOLOR : uint
BGCOLOR sets the background color of your project.
SettingsData
  CONTENT_FOLDER : String
CONTENT_FOLDER is a helper setting designed to keep assets organized.
SettingsData
  DEBUG : Boolean
Enabling DEBUG will turn on Debug mode.
SettingsData
  DEBUG_A3D : Boolean
This debug mode will draw 3D axises and other Away 3D debugging tools Debug modes should NOT be in your finished product.
SettingsData
  DEBUG_COLLISION : Boolean
This debug mode will draw useful red dots and boxes for collision detection.
SettingsData
  DEBUG_UI : Boolean
This debug mode will draw boxes for UI elements.
SettingsData
  DEFAULT_KEYLIST : KeyData
Sets the default key list.
SettingsData
  DEFAULT_LANGUAGE : LanguageData
Sets the default language of the translation system.
SettingsData
  DISABLE_TAB : Boolean
DISABLE_TAB turns off the focus rectangle that occurs when you press tab.
SettingsData
  FLASH_DISPLAYSTATE : String
Flash display state.
SettingsData
  FLASH_QUALITY : String
Default render quality.
SettingsData
  FLASH_SCALEMODE : String
Flash scalemode.
SettingsData
  FLASH_SHOW_DEFAULTCONTEXT : Boolean
Enable/disable the default right click context menu.
SettingsData
  FRAMERATE : int
FRAMERATE sets the framerate of the engine loop.
SettingsData
  GUI_MESSAGE_FORMAT : TextFormat
Sets the default GUI message text format.
SettingsData
  GUI_SCALE : Number
GUI_SCALE sets the scale factor of all Verlocity GUI.
SettingsData
  KEY_DOUBLETAP_TIME : uint
How long can we wait between key presses to check if they've been double tapped? See verInput.KeyIsDoubleTapped.
SettingsData
  KEY_HISTORY_AMOUNT : int
The max amount of keys to store in history.
SettingsData
  PAUSEABLE : Boolean
PAUSABLE is the overall setting that completely disables pausing.
SettingsData
  PAUSEMENU_GUI : Class
With SHOW_PAUSEMENU disabled, you can specify your own pause menu GUI with this setting.
SettingsData
  PAUSE_ONFOCUSLOST : Boolean
SettingsData
  PHYS_GRAVITY : Point
The default gravity to apply on all physics objects if they have gravity enabled.
SettingsData
  RIGHTCLICK_PROMOTE : Boolean
Set if you want a promotional link to your website on the right click menu.
SettingsData
  RIGHTCLICK_PROMOTETEXT : String
Sets the right click promo text.
SettingsData
  RIGHTCLICK_PROMOTEURL : String
Sets the right click promo website.
SettingsData
  SHOW_MESSAGES : Boolean
SHOW_MESSAGES enables/disables VerlocityMessages.
SettingsData
  SHOW_PAUSEMENU : Boolean
SHOW_PAUSEMENU enables/disables the built-in pause menu GUI.
SettingsData
  SHOW_SPLASH : Boolean
Please support Verlocity with this splash intro.
SettingsData
  START_VOLUME : Number
START_VOLUME is the starting volume of your project.
SettingsData
  STATE_TRANSITION_IN : MovieClip
STATE_TRANSITION_IN defines the transition MovieClip that occurs when a state is first appearing (fading in).
SettingsData
  STATE_TRANSITION_OUT : MovieClip
STATE_TRANSITION_OUT defines the transition MovieClip that occurs when a state is being removed (fading out).
SettingsData
Public Methods
 MethodDefined By
  
_Apply(sStage:Stage):void
Do not override this - it sets the Flash settings.
SettingsData
Property Detail
BGCOLORproperty
BGCOLOR:uint

BGCOLOR sets the background color of your project. This is required and is different from Flash's background.


Implementation
    public function get BGCOLOR():uint
    public function set BGCOLOR(value:uint):void
CONTENT_FOLDERproperty 
CONTENT_FOLDER:String

CONTENT_FOLDER is a helper setting designed to keep assets organized.


Implementation
    public function get CONTENT_FOLDER():String
    public function set CONTENT_FOLDER(value:String):void
DEBUGproperty 
DEBUG:Boolean

Enabling DEBUG will turn on Debug mode. Debug modes should NOT be in your finished product. While debug mode is enabled you can use verConsole, among various other tools. To activate the console press ~ on your keyboard.


Implementation
    public function get DEBUG():Boolean
    public function set DEBUG(value:Boolean):void
DEBUG_A3Dproperty 
DEBUG_A3D:Boolean

This debug mode will draw 3D axises and other Away 3D debugging tools Debug modes should NOT be in your finished product.


Implementation
    public function get DEBUG_A3D():Boolean
    public function set DEBUG_A3D(value:Boolean):void
DEBUG_COLLISIONproperty 
DEBUG_COLLISION:Boolean

This debug mode will draw useful red dots and boxes for collision detection. Debug modes should NOT be in your finished product.


Implementation
    public function get DEBUG_COLLISION():Boolean
    public function set DEBUG_COLLISION(value:Boolean):void
DEBUG_UIproperty 
DEBUG_UI:Boolean

This debug mode will draw boxes for UI elements. Debug modes should NOT be in your finished product.


Implementation
    public function get DEBUG_UI():Boolean
    public function set DEBUG_UI(value:Boolean):void
DEFAULT_KEYLISTproperty 
DEFAULT_KEYLIST:KeyData

Sets the default key list.


Implementation
    public function get DEFAULT_KEYLIST():KeyData
    public function set DEFAULT_KEYLIST(value:KeyData):void
DEFAULT_LANGUAGEproperty 
DEFAULT_LANGUAGE:LanguageData

Sets the default language of the translation system.


Implementation
    public function get DEFAULT_LANGUAGE():LanguageData
    public function set DEFAULT_LANGUAGE(value:LanguageData):void
DISABLE_TABproperty 
DISABLE_TAB:Boolean

DISABLE_TAB turns off the focus rectangle that occurs when you press tab. It is recommended you keep this setting enabled to prevent users from bypassing different input behaviors (such as locating hidden buttons).


Implementation
    public function get DISABLE_TAB():Boolean
    public function set DISABLE_TAB(value:Boolean):void
FLASH_DISPLAYSTATEproperty 
FLASH_DISPLAYSTATE:String

Flash display state. Enable/disable full screen on start. To change during runtime use Verlocity.display.EnableFullscreen( true/false );


Implementation
    public function get FLASH_DISPLAYSTATE():String
    public function set FLASH_DISPLAYSTATE(value:String):void
FLASH_QUALITYproperty 
FLASH_QUALITY:String

Default render quality. To change during runtime use Verlocity.display.SetQualty( 1/2/3 );


Implementation
    public function get FLASH_QUALITY():String
    public function set FLASH_QUALITY(value:String):void
FLASH_SCALEMODEproperty 
FLASH_SCALEMODE:String

Flash scalemode. http://help.adobe.com/en_US/AS2LCR/Flash_10.0/help.html?content=00001543.html


Implementation
    public function get FLASH_SCALEMODE():String
    public function set FLASH_SCALEMODE(value:String):void
FLASH_SHOW_DEFAULTCONTEXTproperty 
FLASH_SHOW_DEFAULTCONTEXT:Boolean

Enable/disable the default right click context menu.


Implementation
    public function get FLASH_SHOW_DEFAULTCONTEXT():Boolean
    public function set FLASH_SHOW_DEFAULTCONTEXT(value:Boolean):void
FRAMERATEproperty 
FRAMERATE:int

FRAMERATE sets the framerate of the engine loop. This will also set the frame rate of the Flash application.


Implementation
    public function get FRAMERATE():int
    public function set FRAMERATE(value:int):void
GUI_MESSAGE_FORMATproperty 
GUI_MESSAGE_FORMAT:TextFormat

Sets the default GUI message text format. Messages will only display if SHOW_MESSAGES is on.


Implementation
    public function get GUI_MESSAGE_FORMAT():TextFormat
    public function set GUI_MESSAGE_FORMAT(value:TextFormat):void
GUI_SCALEproperty 
GUI_SCALE:Number

GUI_SCALE sets the scale factor of all Verlocity GUI. This is useful if you have smaller resolutions


Implementation
    public function get GUI_SCALE():Number
    public function set GUI_SCALE(value:Number):void
KEY_DOUBLETAP_TIMEproperty 
KEY_DOUBLETAP_TIME:uint

How long can we wait between key presses to check if they've been double tapped? See verInput.KeyIsDoubleTapped. Less time means less time to double tap.


Implementation
    public function get KEY_DOUBLETAP_TIME():uint
    public function set KEY_DOUBLETAP_TIME(value:uint):void
KEY_HISTORY_AMOUNTproperty 
KEY_HISTORY_AMOUNT:int

The max amount of keys to store in history. This is the longest amount of keys you can compare for verInput.KeyCombo. This also affects the verInput.KeyIsDoubleTapped function.


Implementation
    public function get KEY_HISTORY_AMOUNT():int
    public function set KEY_HISTORY_AMOUNT(value:int):void
PAUSE_ONFOCUSLOSTproperty 
PAUSE_ONFOCUSLOST:Boolean


Implementation
    public function get PAUSE_ONFOCUSLOST():Boolean
    public function set PAUSE_ONFOCUSLOST(value:Boolean):void
PAUSEABLEproperty 
PAUSEABLE:Boolean

PAUSABLE is the overall setting that completely disables pausing. Disabling this will disable pausing completely. It is recommended to leave this enabled.


Implementation
    public function get PAUSEABLE():Boolean
    public function set PAUSEABLE(value:Boolean):void
PAUSEMENU_GUIproperty 
PAUSEMENU_GUI:Class

With SHOW_PAUSEMENU disabled, you can specify your own pause menu GUI with this setting.


Implementation
    public function get PAUSEMENU_GUI():Class
    public function set PAUSEMENU_GUI(value:Class):void
PHYS_GRAVITYproperty 
PHYS_GRAVITY:Point

The default gravity to apply on all physics objects if they have gravity enabled. Note: This can be bypassed by any physics object


Implementation
    public function get PHYS_GRAVITY():Point
    public function set PHYS_GRAVITY(value:Point):void
RIGHTCLICK_PROMOTEproperty 
RIGHTCLICK_PROMOTE:Boolean

Set if you want a promotional link to your website on the right click menu.


Implementation
    public function get RIGHTCLICK_PROMOTE():Boolean
    public function set RIGHTCLICK_PROMOTE(value:Boolean):void
RIGHTCLICK_PROMOTETEXTproperty 
RIGHTCLICK_PROMOTETEXT:String

Sets the right click promo text.


Implementation
    public function get RIGHTCLICK_PROMOTETEXT():String
    public function set RIGHTCLICK_PROMOTETEXT(value:String):void
RIGHTCLICK_PROMOTEURLproperty 
RIGHTCLICK_PROMOTEURL:String

Sets the right click promo website.


Implementation
    public function get RIGHTCLICK_PROMOTEURL():String
    public function set RIGHTCLICK_PROMOTEURL(value:String):void
SHOW_MESSAGESproperty 
SHOW_MESSAGES:Boolean

SHOW_MESSAGES enables/disables VerlocityMessages. They are small text messages notifying the user of any changes to the game engine. Stuff like pausing, volume changes, saving, etc. They are displayed in the top right hand corner.


Implementation
    public function get SHOW_MESSAGES():Boolean
    public function set SHOW_MESSAGES(value:Boolean):void
SHOW_PAUSEMENUproperty 
SHOW_PAUSEMENU:Boolean

SHOW_PAUSEMENU enables/disables the built-in pause menu GUI. You can disable this and use your own pause menu if you specify the pause menu class in the setting PAUSEMENU_GUI, below this setting.


Implementation
    public function get SHOW_PAUSEMENU():Boolean
    public function set SHOW_PAUSEMENU(value:Boolean):void
SHOW_SPLASHproperty 
SHOW_SPLASH:Boolean

Please support Verlocity with this splash intro. :) When splash is enabled, your product will show the Verlocity logo then instantly begin your first state.


Implementation
    public function get SHOW_SPLASH():Boolean
    public function set SHOW_SPLASH(value:Boolean):void
START_VOLUMEproperty 
START_VOLUME:Number

START_VOLUME is the starting volume of your project. This is to prevent games from starting out EAR BLASTINGLY loud.


Implementation
    public function get START_VOLUME():Number
    public function set START_VOLUME(value:Number):void
STATE_TRANSITION_INproperty 
STATE_TRANSITION_IN:MovieClip

STATE_TRANSITION_IN defines the transition MovieClip that occurs when a state is first appearing (fading in). Leave blank if you don't want the transition.


Implementation
    public function get STATE_TRANSITION_IN():MovieClip
    public function set STATE_TRANSITION_IN(value:MovieClip):void
STATE_TRANSITION_OUTproperty 
STATE_TRANSITION_OUT:MovieClip

STATE_TRANSITION_OUT defines the transition MovieClip that occurs when a state is being removed (fading out). Leave blank if you don't want the transition.


Implementation
    public function get STATE_TRANSITION_OUT():MovieClip
    public function set STATE_TRANSITION_OUT(value:MovieClip):void
Method Detail
_Apply()method
public function _Apply(sStage:Stage):void

Do not override this - it sets the Flash settings.

Parameters

sStage:Stage — The stage





Wed Feb 29 2012, 07:04 PM -08:00