SKUPushButton

Introduction

Cross platform solution for basic push buttons.

Methods

-changeTitleLabelText:forStates:

+pushButtonWithBackgroundPropertiesPackage:andForeGroundSpritePropertiesPackage:

+pushButtonWithBackgroundPropertiesPackage:andForeGroundSpritePropertiesPackage:andTitleLabelPropertiesPackage:

+pushButtonWithBackgroundPropertiesPackage:andTitleLabelPropertiesPackage:

+pushButtonWithTitle:

-setTitleLabelStatesWithPackage:

-setTitleSpriteStatesWithPackage:

changeTitleLabelText:forStates:

-(void)changeTitleLabelText:(NSString*)text forStates:(kSKUButtonStates)states; 

Parameters

Discussion

Allows you to change the text value for multiple states in one call.

pushButtonWithBackgroundPropertiesPackage:andForeGroundSpritePropertiesPackage:

+(SKUPushButton*)pushButtonWithBackgroundPropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)backgroundPackage 
        andForeGroundSpritePropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)foregroundPackage; 

Parameters

Return Value

new SKUPushButton object

Discussion

Creates and returns an SKUPushButton with packages provided.

pushButtonWithBackgroundPropertiesPackage:andForeGroundSpritePropertiesPackage:andTitleLabelPropertiesPackage:

+(SKUPushButton*)pushButtonWithBackgroundPropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)backgroundPackage 
        andForeGroundSpritePropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)foregroundPackage 
        andTitleLabelPropertiesPackage:(SKUButtonLabelPropertiesPackage*)titlePackage; 

Parameters

Return Value

new SKUPushButton object

Discussion

Creates and returns an SKUPushButton with packages provided.

pushButtonWithBackgroundPropertiesPackage:andTitleLabelPropertiesPackage:

+(SKUPushButton*)pushButtonWithBackgroundPropertiesPackage:(SKUButtonSpriteStatePropertiesPackage*)backgroundPackage 
        andTitleLabelPropertiesPackage:(SKUButtonLabelPropertiesPackage*)titleLabelPackage; 

Parameters

Return Value

new SKUPushButton object

Discussion

Creates and returns an SKUPushButton with packages provided.

pushButtonWithTitle:

+(SKUPushButton*)pushButtonWithTitle:(NSString*)title; 

Parameters

Return Value

new SKUPushButton object

Discussion

Creates and returns an SKUPushButton with default settings plus the text provided.

setTitleLabelStatesWithPackage:

-(void)setTitleLabelStatesWithPackage:(SKUButtonLabelPropertiesPackage*)package; 

Parameters

Discussion

Allows the passing of a SKUButtonLabelPropertiesPackage to an already created SKUPushButton

setTitleSpriteStatesWithPackage:

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

Parameters

Discussion

Allows the passing of a SKUButtonSpriteStatePropertiesPackage to an already created SKUPushButton

Properties

labelPropertiesDefault

labelPropertiesDisabled

labelPropertiesHovered

labelPropertiesPackage

labelPropertiesPressed

titleLabel

titleSprite

titleSpritePropertiesDefault

titleSpritePropertiesDisabled

titleSpritePropertiesHovered

titleSpritePropertiesPressed

labelPropertiesDefault

@property (nonatomic) SKUButtonLabelProperties* labelPropertiesDefault; 

Discussion

Set this to setup the title label.

labelPropertiesDisabled

@property (nonatomic) SKUButtonLabelProperties* labelPropertiesDisabled; 

Discussion

Set this to setup the title label properties when the button is disabled.

labelPropertiesHovered

@property (nonatomic) SKUButtonLabelProperties* labelPropertiesHovered; 

Discussion

Set this to setup the title label properties when the button is hovered.

labelPropertiesPackage

@property (nonatomic,
    readonly) SKUButtonLabelPropertiesPackage* labelPropertiesPackage; 

Discussion

Readonly access to a package for the label properties

labelPropertiesPressed

@property (nonatomic) SKUButtonLabelProperties* labelPropertiesPressed; 

Discussion

Set this to setup the title label properties when the button is pressed.

titleLabel

@property (nonatomic,
    strong,
    readonly) SKLabelNode* titleLabel; 

Discussion

Read only access to title label.

titleSprite

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

Discussion

Read only access to title sprite.

titleSpritePropertiesDefault

@property (nonatomic) SKUButtonSpriteStateProperties* titleSpritePropertiesDefault; 

Discussion

Properties to use on the title sprite in default state.

titleSpritePropertiesDisabled

@property (nonatomic) SKUButtonSpriteStateProperties* titleSpritePropertiesDisabled; 

Discussion

Properties to use on the title sprite in disabled state.

titleSpritePropertiesHovered

@property (nonatomic) SKUButtonSpriteStateProperties* titleSpritePropertiesHovered; 

Discussion

Properties to use on the title sprite in hovered state.

titleSpritePropertiesPressed

@property (nonatomic) SKUButtonSpriteStateProperties* titleSpritePropertiesPressed; 

Discussion

Properties to use on the title sprite in pressed state.