cocos2d-iphone  2.1
Improved Cocos2D API Reference (iOS version) for developers
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
CCAnimationFrame Class Reference

#import <CCAnimation.h>

+ Collaboration diagram for CCAnimationFrame:

List of all members.

Public Member Functions

(id) - initWithSpriteFrame:delayUnits:userInfo:

Protected Attributes

float _delayUnits
NSDictionary * _userInfo


float delayUnits
NSDictionary * userInfo

Detailed Description

CCAnimationFrame A frame of the animation. It contains information like:

  • sprite frame name
  • # of delay units.
  • offset

Member Function Documentation

- (id) initWithSpriteFrame: (CCSpriteFrame *)  spriteFrame
delayUnits: (float)  delayUnits
userInfo: (NSDictionary *)  userInfo 

initializes the animation frame with a spriteframe, number of delay units and a notification user info

Property Documentation

- (float) delayUnits [read, write, assign]

how many units of time the frame takes

- (CCSpriteFrame*) spriteFrame [read, write, retain]

CCSpriteFrameName to be used

- (NSDictionary*) userInfo [read, write, retain]

A CCAnimationFrameDisplayedNotification notification will be broadcasted when the frame is displayed with this dictionary as UserInfo. If UserInfo is nil, then no notification will be broadcasted.

The documentation for this class was generated from the following file: