SKUToggleButton

Introduction

Cross platform solution for basic toggle buttons.

Methods

-setToggleSpriteOffStatesWithPackage:

-setToggleSpriteOnStatesWithPackage:

+toggleButtonWithBackgroundPropertiesPackage:andForeGroundSpritePropertiesPackage:

+toggleButtonWithBackgroundPropertiesPackage:andForeGroundSpritePropertiesPackage:andToggleOnPackage:andToggleOffPackage:

+toggleButtonWithBackgroundPropertiesPackage:andTitleLabelPropertiesPackage:

+toggleButtonWithBackgroundPropertiesPackage:andTitleLabelPropertiesPackage:andToggleOnPackage:andToggleOffPackage:

+toggleButtonWithTitle:

-toggleOnOff

setToggleSpriteOffStatesWithPackage:

-(void)setToggleSpriteOffStatesWithPackage:(SKUButtonSpriteStatePropertiesPackage*)package; 

Parameters

Discussion

Allows the passing of a SKUButtonSpriteStatePropertiesPackage to an already created SKUToggleButton to update the toggled off states.

setToggleSpriteOnStatesWithPackage:

-(void)setToggleSpriteOnStatesWithPackage:(SKUButtonSpriteStatePropertiesPackage*)package; 

Parameters

Discussion

Allows the passing of a SKUButtonSpriteStatePropertiesPackage to an already created SKUToggleButton to update the toggled on states.

toggleButtonWithBackgroundPropertiesPackage:andForeGroundSpritePropertiesPackage:

+(SKUToggleButton*)
        toggleButtonWithBackgroundPropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)backgroundPackage 
        andForeGroundSpritePropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)foregroundPackage; 

Parameters

Return Value

new SKUToggleButton object

Discussion

Creates and returns an SKUToggleButton with packages provided.

toggleButtonWithBackgroundPropertiesPackage:andForeGroundSpritePropertiesPackage:andToggleOnPackage:andToggleOffPackage:

+(SKUToggleButton*)
        toggleButtonWithBackgroundPropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)backgroundPackage 
        andForeGroundSpritePropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)foregroundPackage 
        andToggleOnPackage:(SKUButtonSpriteStatePropertiesPackage*)toggleSpriteOnPropertiesPackage 
        andToggleOffPackage:(SKUButtonSpriteStatePropertiesPackage*)toggleSpriteOffPropertiesPackage; 

Parameters

Return Value

new SKUToggleButton object

Discussion

Creates and returns an SKUToggleButton with packages provided.

toggleButtonWithBackgroundPropertiesPackage:andTitleLabelPropertiesPackage:

+(SKUToggleButton*)
        toggleButtonWithBackgroundPropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)backgroundPackage 
        andTitleLabelPropertiesPackage:(SKUButtonLabelPropertiesPackage*)foregroundPackage; 

Parameters

Return Value

new SKUToggleButton object

Discussion

Creates and returns an SKUToggleButton with packages provided.

toggleButtonWithBackgroundPropertiesPackage:andTitleLabelPropertiesPackage:andToggleOnPackage:andToggleOffPackage:

+(SKUToggleButton*)
        toggleButtonWithBackgroundPropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)backgroundPackage 
        andTitleLabelPropertiesPackage:(SKUButtonLabelPropertiesPackage*)foregroundPackage 
        andToggleOnPackage:(SKUButtonSpriteStatePropertiesPackage*)toggleSpriteOnPropertiesPackage 
        andToggleOffPackage:(SKUButtonSpriteStatePropertiesPackage*)toggleSpriteOffPropertiesPackage; 

Parameters

Return Value

new SKUToggleButton object

Discussion

Creates and returns an SKUToggleButton with packages provided.

toggleButtonWithTitle:

+(SKUToggleButton*)toggleButtonWithTitle:(NSString*)title; 

Parameters

Return Value

new SKUToggleButton object

Discussion

Creates and returns an SKUToggleButton with title provided.

toggleOnOff

-(void)toggleOnOff; 

Discussion

Toggles button on/off state.

Properties

on

toggleSprite

toggleSpritePropertiesOffDefault

toggleSpritePropertiesOffDisabled

toggleSpritePropertiesOffHovered

toggleSpritePropertiesOffPressed

toggleSpritePropertiesOnDefault

toggleSpritePropertiesOnDisabled

toggleSpritePropertiesOnHovered

toggleSpritePropertiesOnPressed

on

@property (nonatomic) BOOL on; 

Discussion

Boolean determining whether the button is in an on state or not.

toggleSprite

@property (nonatomic,
    strong,
    readonly) SKSpriteNode* toggleSprite; 

Discussion

Read only access to toggle sprite.

toggleSpritePropertiesOffDefault

@property (nonatomic) SKUButtonSpriteStateProperties* toggleSpritePropertiesOffDefault; 

Discussion

Properties to use on the toggle sprite in default off state.

toggleSpritePropertiesOffDisabled

@property (nonatomic) SKUButtonSpriteStateProperties* toggleSpritePropertiesOffDisabled; 

Discussion

Properties to use on the toggle sprite in disabled off state.

toggleSpritePropertiesOffHovered

@property (nonatomic) SKUButtonSpriteStateProperties* toggleSpritePropertiesOffHovered; 

Discussion

Properties to use on the toggle sprite in hovered off state.

toggleSpritePropertiesOffPressed

@property (nonatomic) SKUButtonSpriteStateProperties* toggleSpritePropertiesOffPressed; 

Discussion

Properties to use on the toggle sprite in pressed off state.

toggleSpritePropertiesOnDefault

@property (nonatomic) SKUButtonSpriteStateProperties* toggleSpritePropertiesOnDefault; 

Discussion

Properties to use on the toggle sprite in default on state.

toggleSpritePropertiesOnDisabled

@property (nonatomic) SKUButtonSpriteStateProperties* toggleSpritePropertiesOnDisabled; 

Discussion

Properties to use on the toggle sprite in disabled on state.

toggleSpritePropertiesOnHovered

@property (nonatomic) SKUButtonSpriteStateProperties* toggleSpritePropertiesOnHovered; 

Discussion

Properties to use on the toggle sprite in hovered on state.

toggleSpritePropertiesOnPressed

@property (nonatomic) SKUButtonSpriteStateProperties* toggleSpritePropertiesOnPressed; 

Discussion

Properties to use on the toggle sprite in pressed on state.