Class cc.MenuItemSprite

Class Summary
Constructor Attributes Constructor Name and Description
 
cc.MenuItemSprite(normalSprite, selectedSprite, three, four, five)
CCMenuItemSprite accepts CCNode objects as items.

Method Summary

Class Detail

cc.MenuItemSprite(normalSprite, selectedSprite, three, four, five)
CCMenuItemSprite accepts CCNode objects as items.
The images has 3 different states:
- unselected image
- selected image
- disabled image
var item = new cc.MenuItemSprite(normalImage)//create a menu item from a sprite with no functionality
var item = new cc.MenuItemSprite(normalImage, selectedImage)//create a menu Item, nothing will happen when clicked
var item = new cc.MenuItemSprite(normalImage, SelectedImage, disabledImage)//same above, but with disabled state image
var item = new cc.MenuItemSprite(normalImage, SelectedImage, 'callback', targetNode)//create a menu item, when clicked runs targetNode.callback()
var item = new cc.MenuItemSprite(normalImage, SelectedImage, disabledImage, targetNode.callback, targetNode)
//same as above, but with disabled image, and passing in callback function
Parameters:
{Image|Null} normalSprite
normal state image
{Image|Null} selectedSprite
selected state image
{Image|cc.Node|Null} three
disabled state image OR target node
{String|function|cc.Node|Null} four
callback function name in string or actual function, OR target Node
{String|function|Null} five
callback function name in string or actual function

Field Detail

{cc.Sprite} disabledImage
- Sprite in disabled state
{cc.Sprite} normalImage
- Sprite in normal state
{cc.Sprite} selectedImage
- Sprite in selected state

Method Detail

  • <static> {cc.MenuItemSprite} cc.MenuItemSprite.create(normalSprite, selectedSprite, three, four, five)
    create a menu item from sprite
    Parameters:
    {Image} normalSprite
    normal state image
    {Image|Null} selectedSprite
    selected state image
    {Image|cc.Node|Null} three
    disabled state image OR target node
    {String|function|cc.Node|Null} four
    callback function name in string or actual function, OR target Node
    {String|function|Null} five
    callback function name in string or actual function
    Deprecated:
    since v3.0 please use new cc.MenuItemSprite(normalSprite, selectedSprite, three, four, five) instead
    Returns:
    {cc.MenuItemSprite}
  • ctor(normalSprite, selectedSprite, three, four, five)
    Constructor of cc.MenuItemSprite
    Parameters:
    {Image|Null} normalSprite
    normal state image
    {Image|Null} selectedSprite
    selected state image
    {Image|cc.Node|Null} three
    disabled state image OR target node
    {String|function|cc.Node|Null} four
    callback function name in string or actual function, OR target Node
    {String|function|Null} five
    callback function name in string or actual function
  • {cc.Color} getColor()
    return the color of cc.MenuItemSprite
    Returns:
    {cc.Color}
  • {cc.Sprite} getDisabledImage()
    return the disabled status of cc.MenuItemSprite
    Returns:
    {cc.Sprite}
  • {cc.Sprite} getNormalImage()
    return the normal status image(cc.Sprite)
    Returns:
    {cc.Sprite}
  • {Number} getOpacity()
    return the opacity of cc.MenuItemSprite
    Returns:
    {Number} opacity from 0 - 255
  • {cc.Sprite} getSelectedImage()
    return the selected status image(cc.Sprite) of cc.MenuItemSprite
    Returns:
    {cc.Sprite}
  • {Boolean} initWithNormalSprite(normalSprite, selectedSprite, disabledSprite, callback, target)
    initializes cc.MenuItemSprite with a cc.Sprite
    Parameters:
    {cc.Node} normalSprite
    {cc.Node} selectedSprite
    {cc.Node} disabledSprite
    {function|String} callback
    {cc.Node} target
    Returns:
    {Boolean}
  • selected()
    menu item is selected (runs callback)
  • setColor(color)
    set the color for cc.MenuItemSprite
    Parameters:
    {cc.Color} color
  • setDisabledImage(disabledImage)
    set the disabled status image(cc.Sprite)
    Parameters:
    {cc.Sprite} disabledImage
  • setEnabled(bEnabled)
    set cc.MenuItemSprite enable to receive the touch event
    Parameters:
    {Boolean} bEnabled
  • setNormalImage(normalImage)
    set the normal status image(cc.Sprite)
    Parameters:
    {cc.Sprite} normalImage
  • setOpacity(opacity)
    set the opacity for cc.MenuItemSprite
    Parameters:
    {Number} opacity
    0 - 255
  • setSelectedImage(selectedImage)
    set the selected status image(cc.Sprite)
    Parameters:
    {cc.Sprite} selectedImage
  • unselected()
    menu item goes back to unselected state