Inherits from NSObject
Declared in KKStartupConfig.h

Overview

This class contains all the config.lua settings at runtime. Each property corresponds to the correspondingly named config.lua parameter, with the exception that config.lua parameter have their first letter uppercased (this is a technical, Objective-C runtime issue). For example, the property gLViewColorFormat is the config.lua setting GLViewColorFormat.

Tasks

  •   supportsInterfaceOrientationPortrait

    YES if portrait orientation is supported. Can be changed at runtime. Original setting is obtained from “Supported Device Orientation” setting in Xcode –> Target –> Summary pane respectively from UISupportedDeviceOrientations key in Info.plist.

         property
  •   supportsInterfaceOrientationPortraitUpsideDown

    YES if portrait upside down orientation is supported. Can be changed at runtime. Original setting is obtained from “Supported Device Orientation” setting in Xcode –> Target –> Summary pane respectively from UISupportedDeviceOrientations key in Info.plist.

         property
  •   supportsInterfaceOrientationLandscapeLeft

    YES if landscape left orientation is supported. Can be changed at runtime. Original setting is obtained from “Supported Device Orientation” setting in Xcode –> Target –> Summary pane respectively from UISupportedDeviceOrientations key in Info.plist.

         property
  •   supportsInterfaceOrientationLandscapeRight

    YES if landscape right orientation is supported. Can be changed at runtime. Original setting is obtained from “Supported Device Orientation” setting in Xcode –> Target –> Summary pane respectively from UISupportedDeviceOrientations key in Info.plist.

         property
  •   gLViewColorFormat

    The color format of the OpenGL View.

         property
  •   gLViewDepthFormat

    The depth (z-buffering) format of the OpenGL View.

         property
  •   gLViewMultiSampling

    Enable multisampling (anti-aliasing) for edge removal. On older iOS devices multisampling can noticeably reduce rendering performance. See also: http://en.wikipedia.org/wiki/Multisample_anti-aliasing

         property
  •   gLViewNumberOfSamples

    If multisampling is enabled, sets the number of samples. On iOS devices valid values are 1, 2 and 4. On Mac OS this depends on the graphics card and you may be able to use 8 or 16 as well.

         property
  •   defaultTexturePixelFormat

    Specifies the pixel format for all textures. By default all textures are 24-bit with 8-bit alpha but if you reduce the color bit depth of your textures and don’t need an alpha channel you can preserve half the texture memory. The TexturePacker tool http://www.texturepacker.com will help you with this.

         property
  •   maxFrameRate

    Sets the maximum framerate of your game. Defaults to 60.

         property
  •   displayFPS

    Enables the FPS counter in the lower left corner of the screen. Keep in mind that the FPS for iOS apps running in the iOS Simulator is not indicative of real performance on the device (it could be ten times that, or one tenth). Also logging and an attached debugger (running from within Xcode) can negatively affect performance.

         property
  •   enableUserInteraction

    Enables user interaction for the entire app. If disabled, the app will not receive touches, accelerometer, keyboard, etc events from the user. Ignored on Mac OS.

         property
  •   enableMultiTouch

    Allow the app to process multi-touch events. If disabled, app will only receive single touch events. Ignored on Mac OS.

         property
  •   enable2DProjection

    Changes the OpenGL view to 2D projection mode. This is commonly only used when working with tilemaps, or when you want to fine-tune the Z-order of nodes via the vertexZ property. That allows you to override Cocos2D’s z-ordering (addChild:z: and reorderChild:z:).

         property
  •   enableRetinaDisplaySupport

    Allows your app to use Retina graphics (file suffix “-hd”) for assets like images, tilemaps, particle effects, and so on.

         property
  •   enableGLViewNodeHitTesting

    If YES (default: NO) will test each touch began (iOS) or mouse click (Mac OS) location if it “hit” a CCNode in the scene hierarchy. It calls [node containsPoint:location] for each node in the scene hierarchy. If a node is “hit”, then the touch/click is processed by the Cocos2D OpenGL view. Otherwise it is passed on to underlying views.

         property
  •   enableAdBanner

    Allows you to enable the Ad banner implementation of the KKRootViewController.

         property
  •   placeBannerOnBottom

    Allows you to move the ad banner from its default top position to the bottom of the screen.

         property
  •   loadOnlyPortraitBanners

    iAd specific: can be used to reduce Internet traffic. If your app only ever uses or rotates to Portrait orientations, set this property to YES.

         property
  •   loadOnlyLandscapeBanners

    iAd specific: can be used to reduce Internet traffic. If your app only ever uses or rotates to Landscape orientations, set this property to YES.

         property
  •   adProviders

    Comma seperated list of ad providers, and their priority. Currently supports: iAd, AdMob.

         property
  •   adMobFirstAdDelay

    AdMob specific: set the time (in seconds) before the very first ad after starting the app should be displayed.

         property
  •   adMobRefreshRate

    AdMob specific: set the ad refresh rate. AdMob allows a refresh rate between 12 and 120 seconds.

         property
  •   adMobPublisherID

    AdMob specific: your AdMob publisher ID.

         property
  •   adMobTestMode

    AdMob specific: only display test ads to avoid requesting invalid impressions. This setting is ignored in Release (Archive) builds so that you don’t accidentally publish an App with test mode enabled.

         property
  •   enableStatusBar

    Allows you to enable or disable (hide) the iPhone Statusbar (the top bar that displays the current time, battery lifetime, etc). Has no effect when building for Mac.

         property
  •   firstSceneClassName

    You can tell Kobold2D which CCScene or CCLayer derived class should be the first scene loaded by the CCDirector runWithScene method. This must be the name of the class as a string (in double quotes), and not the name of the file(s) the class is defined in.

         property
  •   autoScale

    Mac OS only. Allows the OpenGL view in the app window to be scaled automatically when the window size changes. If you disable this you should also disallow resizing of the window by the user.

         property
  •   acceptsMouseMovedEvents

    Enable this if you need to track simple mouse movement events in your app. Disabled by default because every move of the mouse generates a new event, which is wasteful if you don’t respond to ccMouseMoved events.

         property
  •   enableFullScreen

    Enable fullscreen rendering in Mac apps.

         property
  • + config

    autorelease initializer

Properties

acceptsMouseMovedEvents

Enable this if you need to track simple mouse movement events in your app. Disabled by default because every move of the mouse generates a new event, which is wasteful if you don’t respond to ccMouseMoved events.

@property (nonatomic) BOOL acceptsMouseMovedEvents

Declared In

KKStartupConfig.h

adMobFirstAdDelay

AdMob specific: set the time (in seconds) before the very first ad after starting the app should be displayed.

@property (nonatomic) int adMobFirstAdDelay

Declared In

KKStartupConfig.h

adMobPublisherID

AdMob specific: your AdMob publisher ID.

@property (nonatomic, copy) NSString *adMobPublisherID

Declared In

KKStartupConfig.h

adMobRefreshRate

AdMob specific: set the ad refresh rate. AdMob allows a refresh rate between 12 and 120 seconds.

@property (nonatomic) int adMobRefreshRate

Declared In

KKStartupConfig.h

adMobTestMode

AdMob specific: only display test ads to avoid requesting invalid impressions. This setting is ignored in Release (Archive) builds so that you don’t accidentally publish an App with test mode enabled.

@property (nonatomic) BOOL adMobTestMode

Declared In

KKStartupConfig.h

adProviders

Comma seperated list of ad providers, and their priority. Currently supports: iAd, AdMob.

@property (nonatomic, copy) NSString *adProviders

Discussion

Valid settings: “iAd, AdMob” – display iAd ad banners where available, and where iAd isn’t available AdMob banners are used “iAd” – display only iAd ad banners where available, none otherwise “AdMob” – display only AdMob ad banners “AdMob, iAd” – same as “AdMob” because AdMob is supported on all devices with iOS 3, whereas iAd is only available on iOS 4.

Declared In

KKStartupConfig.h

autoScale

Mac OS only. Allows the OpenGL view in the app window to be scaled automatically when the window size changes. If you disable this you should also disallow resizing of the window by the user.

@property (nonatomic) BOOL autoScale

Declared In

KKStartupConfig.h

defaultTexturePixelFormat

Specifies the pixel format for all textures. By default all textures are 24-bit with 8-bit alpha but if you reduce the color bit depth of your textures and don’t need an alpha channel you can preserve half the texture memory. The TexturePacker tool http://www.texturepacker.com will help you with this.

@property (nonatomic) int defaultTexturePixelFormat

Discussion

Valid config.lua values for this setting are: – TexturePixelFormat.Automatic – TexturePixelFormat.RGBA8888 – TexturePixelFormat.RGB565 – TexturePixelFormat.A8 – TexturePixelFormat.I8 – TexturePixelFormat.IA88 – TexturePixelFormat.RGBA4444 – TexturePixelFormat.RGB5A1 – TexturePixelFormat.PVRTC4 – TexturePixelFormat.PVRTC2 .

The Automatic mode defaults to RGBA8888 which is the default texture pixel format (24-bit colors, 8-bit alpha). Compatible and using half the memory is RGBA4444 which has 12-bit colors and 4-bit alpha, and obviously reduced image quality. A better alternative would be RGB565 which gives you 16-bit colors but no alpha, or RGB5A1 which gives you 15-bit colors and at least 1-bit alpha. This means your images can have “see-through” parts but each pixel can be either completely translucent or completely opaque. This is good enough for sprite masks. The pixel format A8 is used by particle effects by default, it provides 256 colors (8-bit). Useful for single-color textures when you really need to preserve memory and faster performance than 16-bit or 32-bit textures.

Declared In

KKStartupConfig.h

displayFPS

Enables the FPS counter in the lower left corner of the screen. Keep in mind that the FPS for iOS apps running in the iOS Simulator is not indicative of real performance on the device (it could be ten times that, or one tenth). Also logging and an attached debugger (running from within Xcode) can negatively affect performance.

@property (nonatomic) BOOL displayFPS

Discussion

Important: when enabling this setting you must have the file fps_images.png in your project’s resources. Otherwise your app will report an error on startup.

To change how often the FPS counter is updated, open the ccConfig.h file (of Cocos2D) and look for the macro CC_DIRECTOR_FPS_INTERVAL.

Note: be sure to turn this setting off when publishing your app to the App Store!

Declared In

KKStartupConfig.h

enable2DProjection

Changes the OpenGL view to 2D projection mode. This is commonly only used when working with tilemaps, or when you want to fine-tune the Z-order of nodes via the vertexZ property. That allows you to override Cocos2D’s z-ordering (addChild:z: and reorderChild:z:).

@property (nonatomic) BOOL enable2DProjection

Declared In

KKStartupConfig.h

enableAdBanner

Allows you to enable the Ad banner implementation of the KKRootViewController.

@property (nonatomic) BOOL enableAdBanner

Declared In

KKStartupConfig.h

enableFullScreen

Enable fullscreen rendering in Mac apps.

@property (nonatomic) BOOL enableFullScreen

Declared In

KKStartupConfig.h

enableGLViewNodeHitTesting

If YES (default: NO) will test each touch began (iOS) or mouse click (Mac OS) location if it “hit” a CCNode in the scene hierarchy. It calls [node containsPoint:location] for each node in the scene hierarchy. If a node is “hit”, then the touch/click is processed by the Cocos2D OpenGL view. Otherwise it is passed on to underlying views.

@property (nonatomic) BOOL enableGLViewNodeHitTesting

Discussion

This setting is only needed if you want to have UIView/NSView both in the foreground and in the background of the Cocos2D OpenGL view, and both foreground (Cocos2D and/or UIKit/AppKit foreground views) and background views should process user input. Normally the Cocos2D view will not pass touches/clicks to underlying views since it spans the entire screen/window.

Declared In

KKStartupConfig.h

enableMultiTouch

Allow the app to process multi-touch events. If disabled, app will only receive single touch events. Ignored on Mac OS.

@property (nonatomic) BOOL enableMultiTouch

Declared In

KKStartupConfig.h

enableRetinaDisplaySupport

Allows your app to use Retina graphics (file suffix “-hd”) for assets like images, tilemaps, particle effects, and so on.

@property (nonatomic) BOOL enableRetinaDisplaySupport

Discussion

Note: if you enable Retina support but do not provide HD graphics your app will be rendered on Retina devices in the lower, left quarter of the screen as a tiny version of the app. If you can’t provide HD images there’s no point in enabling Retina support.

Declared In

KKStartupConfig.h

enableStatusBar

Allows you to enable or disable (hide) the iPhone Statusbar (the top bar that displays the current time, battery lifetime, etc). Has no effect when building for Mac.

@property (nonatomic) BOOL enableStatusBar

Discussion

Note: if the statusbar is enabled the Cocos2D OpenGL view will still be fullscreen. It is up to you to ensure that essential objects are not (partially) obstructed by the Statusbar.

Declared In

KKStartupConfig.h

enableUserInteraction

Enables user interaction for the entire app. If disabled, the app will not receive touches, accelerometer, keyboard, etc events from the user. Ignored on Mac OS.

@property (nonatomic) BOOL enableUserInteraction

Declared In

KKStartupConfig.h

firstSceneClassName

You can tell Kobold2D which CCScene or CCLayer derived class should be the first scene loaded by the CCDirector runWithScene method. This must be the name of the class as a string (in double quotes), and not the name of the file(s) the class is defined in.

@property (nonatomic, copy) NSString *firstSceneClassName

Discussion

Example usage in config.lua: – FirstSceneClassName = “MyHelloWorldScene”,

Declared In

KKStartupConfig.h

gLViewColorFormat

The color format of the OpenGL View.

@property (nonatomic) int gLViewColorFormat

Discussion

Valid config.lua values for this setting are: – GLViewColorFormat.RGBA8888 – GLViewColorFormat.RGB565 .

RGBA8888 is 32-bit with alpha channel, RGB565 is 16-bit with no alpha channel. RGB565 is the default because it is faster and sufficient for most uses. RGBA8888 provides the best visual quality in particular for images with gradients, and it allows the OpenGL view itself to be transparent which is required if you want to have UIKit views in the background (behind the Cocos2D view).

Declared In

KKStartupConfig.h

gLViewDepthFormat

The depth (z-buffering) format of the OpenGL View.

@property (nonatomic) int gLViewDepthFormat

Discussion

Valid config.lua values for this setting are: – 0 – GLViewDepthFormat.DepthNone – GLViewDepthFormat.Depth16Bit – GLViewDepthFormat.Depth24Bit .

Depth buffering is normally not needed and reduces rendering performance, so the default value is DepthNone (equals 0). Depth16Bit and Depth24Bit set the depth (Z) buffer to 16-bit respectively 24-bit (more accurate, higher memory usage). If you want to use Cocos3D, 3D or Grid Actions (eg PageTurn3D), or isometric tilemaps (and in some cases orthogonal tilemaps) you should enable depth buffering. Prefer to use a 16-bit buffer unless you see artifacts, in that case a 24-bit buffer may help.

Declared In

KKStartupConfig.h

gLViewMultiSampling

Enable multisampling (anti-aliasing) for edge removal. On older iOS devices multisampling can noticeably reduce rendering performance. See also: http://en.wikipedia.org/wiki/Multisample_anti-aliasing

@property (nonatomic) BOOL gLViewMultiSampling

Discussion

For Mac OS computers consider allowing the user to change this setting as the performance and visual quality greatly depends on the graphics card and screen resolution.

Declared In

KKStartupConfig.h

gLViewNumberOfSamples

If multisampling is enabled, sets the number of samples. On iOS devices valid values are 1, 2 and 4. On Mac OS this depends on the graphics card and you may be able to use 8 or 16 as well.

@property (nonatomic) int gLViewNumberOfSamples

Declared In

KKStartupConfig.h

loadOnlyLandscapeBanners

iAd specific: can be used to reduce Internet traffic. If your app only ever uses or rotates to Landscape orientations, set this property to YES.

@property (nonatomic) BOOL loadOnlyLandscapeBanners

Declared In

KKStartupConfig.h

loadOnlyPortraitBanners

iAd specific: can be used to reduce Internet traffic. If your app only ever uses or rotates to Portrait orientations, set this property to YES.

@property (nonatomic) BOOL loadOnlyPortraitBanners

Declared In

KKStartupConfig.h

maxFrameRate

Sets the maximum framerate of your game. Defaults to 60.

@property (nonatomic) int maxFrameRate

Discussion

On iOS Devices the maximum framerate is limited to 60 frames per second by the display hardware. On Mac OS you may be able to go higher but at little benefit, 60 fps is already very, very smooth.

Note that this setting can not magically increase your framerate. But you can intentionally limit your app’s framerate to a lower framerate, in particular if your app is experiencing a highly fluctuating framerate. If you see the framerate counter jump between 40 to 60 fps it can be helpful to limit the framerate to 40 fps since a steady framerate is very important, in particular for some games. You also reduce the number of times your game is updated, which in turn may even result in a slightly better performance.

Note that on iOS with the DirectorType.DisplayLink you can only expect to get a framerate of 60, 30 (60 divided by 2), 20 (60 divided by 3), 15 (60 divided by 4), 12 (60 divided by 5), and so on. The DisplayLink director links the update rate to the screen refresh rate. If the update takes just tiny bit longer than 16.666 milliseconds the DisplayLink director will have to skip this frame and will only refresh the screen after 33.333 milliseconds. That’s why it can be very important for DisplayLink director to limit the framerate to 30 fps if your app frequently drops below 60 fps. You’ll get a stable framerate and twice the CPU time per frame.

Declared In

KKStartupConfig.h

placeBannerOnBottom

Allows you to move the ad banner from its default top position to the bottom of the screen.

@property (nonatomic) BOOL placeBannerOnBottom

Declared In

KKStartupConfig.h

supportsInterfaceOrientationLandscapeLeft

YES if landscape left orientation is supported. Can be changed at runtime. Original setting is obtained from “Supported Device Orientation” setting in Xcode –> Target –> Summary pane respectively from UISupportedDeviceOrientations key in Info.plist.

@property (nonatomic) BOOL supportsInterfaceOrientationLandscapeLeft

Declared In

KKStartupConfig.h

supportsInterfaceOrientationLandscapeRight

YES if landscape right orientation is supported. Can be changed at runtime. Original setting is obtained from “Supported Device Orientation” setting in Xcode –> Target –> Summary pane respectively from UISupportedDeviceOrientations key in Info.plist.

@property (nonatomic) BOOL supportsInterfaceOrientationLandscapeRight

Declared In

KKStartupConfig.h

supportsInterfaceOrientationPortrait

YES if portrait orientation is supported. Can be changed at runtime. Original setting is obtained from “Supported Device Orientation” setting in Xcode –> Target –> Summary pane respectively from UISupportedDeviceOrientations key in Info.plist.

@property (nonatomic) BOOL supportsInterfaceOrientationPortrait

Declared In

KKStartupConfig.h

supportsInterfaceOrientationPortraitUpsideDown

YES if portrait upside down orientation is supported. Can be changed at runtime. Original setting is obtained from “Supported Device Orientation” setting in Xcode –> Target –> Summary pane respectively from UISupportedDeviceOrientations key in Info.plist.

@property (nonatomic) BOOL supportsInterfaceOrientationPortraitUpsideDown

Declared In

KKStartupConfig.h

Class Methods

config

autorelease initializer

+ (id)config

Declared In

KKStartupConfig.h