Tasks

Other Methods

•   dirty

  whether or not the Sprite needs to be updated in the Atlas

  property
•   quad

  the quad (tex coords, vertex coords and color) information

  property
•   atlasIndex

  The index used on the TextureAtlas. Don’t modify this value unless you know what you are doing

  property
•   textureRect

  returns the texture rect of the CCSprite in points

  property
•   textureRectRotated

  returns whether or not the texture rectangle is rotated

  property
•   flipX

  whether or not the sprite is flipped horizontally. It only flips the texture of the sprite, and not the texture of the sprite’s children. Also, flipping the texture doesn’t alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use:

  property
•   flipY

  whether or not the sprite is flipped vertically. It only flips the texture of the sprite, and not the texture of the sprite’s children. Also, flipping the texture doesn’t alter the anchorPoint. If you want to flip the anchorPoint too, and/or to flip the children too use:

  property
•   textureAtlas

  weak reference of the CCTextureAtlas used when the sprite is rendered using a CCSpriteBatchNode

  property
•   batchNode

  weak reference to the CCSpriteBatchNode that renders the CCSprite

  property
•   offsetPosition

  offset position in points of the sprite in points. Calculated automatically by editors like Zwoptex.

  property
•   blendFunc

  conforms to CCTextureProtocol protocol

  property
• + spriteWithTexture:

  Creates an sprite with a texture. The rect used will be the size of the texture. The offset will be (0,0).

• + spriteWithTexture:rect:

  Creates an sprite with a texture and a rect. The offset will be (0,0).

• + spriteWithSpriteFrame:

  Creates an sprite with an sprite frame.

• + spriteWithSpriteFrameName:

  Creates an sprite with an sprite frame name. An CCSpriteFrame will be fetched from the CCSpriteFrameCache by name. If the CCSpriteFrame doesn’t exist it will raise an exception.

• + spriteWithFile:

  Creates an sprite with an image filename. The rect used will be the size of the image. The offset will be (0,0).

• + spriteWithFile:rect:

  Creates an sprite with an image filename and a rect. The offset will be (0,0).

• + spriteWithCGImage:key:

  Creates an sprite with a CGImageRef and a key. The key is used by the CCTextureCache to know if a texture was already created with this CGImage. For example, a valid key is: @“_spriteframe_01”. If key is nil, then a new texture will be created each time by the CCTextureCache.

• – initWithTexture:

  Initializes an sprite with a texture. The rect used will be the size of the texture. The offset will be (0,0).

• – initWithTexture:rect:

  Initializes an sprite with a texture and a rect in points (unrotated) The offset will be (0,0).

• – initWithTexture:rect:rotated:

  Initializes an sprite with a texture and a rect in points, optionally rotated. The offset will be (0,0). IMPORTANT: This is the designated initializer.

• – initWithSpriteFrame:

  Initializes an sprite with an sprite frame.

• – initWithSpriteFrameName:

  Initializes an sprite with an sprite frame name. An CCSpriteFrame will be fetched from the CCSpriteFrameCache by name. If the CCSpriteFrame doesn’t exist it will raise an exception.

• – initWithFile:

  Initializes an sprite with an image filename. The rect used will be the size of the image. The offset will be (0,0).

• – initWithFile:rect:

  Initializes an sprite with an image filename, and a rect. The offset will be (0,0).

• – initWithCGImage:key:

  Initializes an sprite with a CGImageRef and a key The key is used by the CCTextureCache to know if a texture was already created with this CGImage. For example, a valid key is: @“_spriteframe_01”. If key is nil, then a new texture will be created each time by the CCTextureCache.

• – updateTransform

  updates the quad according the the rotation, position, scale values.

• – setTextureRect:

  set the texture rect of the CCSprite in points. It will call setTextureRect:rotated:untrimmedSize with rotated = NO, and utrimmedSize = rect.size.

• – setTextureRect:rotated:untrimmedSize:

  set the texture rect, rectRotated and untrimmed size of the CCSprite in points. It will update the texture coordinates and the vertex rectangle.

• – setVertexRect:

  set the vertex rect. It will be called internally by setTextureRect. Useful if you want to create 2x images from SD images in Retina Display. Do not call it manually. Use setTextureRect instead.

• – setDisplayFrame:

  sets a new display frame to the CCSprite.

• – isFrameDisplayed:

  returns whether or not a CCSpriteFrame is being displayed

• – displayFrame

  returns the current displayed frame.

• – setDisplayFrameWithAnimationName:index:

  changes the display frame with animation name and index. The animation name will be get from the CCAnimationCache

Other Methods

•   opacity

  opacity: conforms to CCRGBAProtocol protocol

  property
•   color

  RGB colors: conforms to CCRGBAProtocol protocol

  property
•   usesSpriteSheet

  whether or not the Sprite is rendered using a CCSpriteSheet

  property
•   spriteSheet

  weak reference to the CCSpriteSheet that renders the CCSprite

  property
•   honorParentTransform

  whether or not to transform according to its parent transfomrations. Useful for health bars. eg: Don’t rotate the health bar, even if the parent rotates. IMPORTANT: Only valid if it is rendered using an CCSpriteSheet.

  property
• + spriteWithTexture:rect:offset:

  Creates an sprite with a texture, a rect and offset.

• + spriteWithCGImage:

  Creates an sprite with a CGImageRef. (Deprecated: Use spriteWithCGImage:key: instead. Will be removed in v1.0 final)

• + spriteWithSpriteSheet:rect:

  Creates an sprite with an CCSpriteSheet and a rect

• – initWithCGImage:

  Initializes an sprite with a CGImageRef (Deprecated: Use spriteWithCGImage:key: instead. Will be removed in v1.0 final)

• – initWithSpriteSheet:rect:

  Initializes an sprite with an CCSpriteSheet and a rect

• – useSelfRender

  tell the sprite to use self-render.

• – useSpriteSheetRender:

  tell the sprite to use sprite sheet render.

• – displayedFrame

  returns the current displayed frame.

• – setDisplayFrame:index:

  changes the display frame based on an animation and an index.

• – animationByName:

  returns an Animation given it’s name.

• – addAnimation:

  adds an Animation to the Sprite.

KoboldExtensions Methods

• – playAnimWithFormat:numFrames:firstIndex:delay:animateTag:

  Plays an anim once with the given file format (eg @“playeranim%i.png”) with the given number of frames and a starting index. The animateTag parameter is the tag given to the action playing the animation, so that you can stop it by tag.

• – playAnimLoopedWithFormat:numFrames:firstIndex:delay:animateTag:

  Plays an anim looped with the given file format (eg @“playeranim%i.png”) with the given number of frames and a starting index. The animateTag parameter is the tag given to the action playing the animation, so that you can stop it by tag.

• – playAnimAndRemoveWithFormat:numFrames:firstIndex:delay:animateTag:

  Plays an anim once with the given file format (eg @“playeranim%i.png”) with the given number of frames and a starting index. The animateTag parameter is the tag given to the action playing the animation, so that you can stop it by tag. When the anim has cycled through all frames, the node running the animation will be removed from its parent. Useful for one-off animations, like an explosion, smoke-puff, blood splat, etc.

• – playAnimWithFormat:numFrames:firstIndex:delay:animateTag:restoreOriginalFrame:

  Variant that allows to set the restoreOriginalFrame property.

• – playAnimLoopedWithFormat:numFrames:firstIndex:delay:animateTag:restoreOriginalFrame:

  Variant that allows to set the restoreOriginalFrame property.

• – playAnimAndRemoveWithFormat:numFrames:firstIndex:delay:animateTag:restoreOriginalFrame:

  Variant that allows to set the restoreOriginalFrame property.

• + spriteWithSpriteFrameNameOrFile:

  First, checks if the string can be found in the spriteFrameCache, if not it will try to load the string assuming its a file name.

• + spriteWithRenderTexture:

  Creates an autoreleased sprite from a CCRenderTexture

Deprecated Methods

• + spriteWithBatchNode:rect:
• – initWithBatchNode:rect: