Split the CCAction.h header into a public/private one. CCAction.tag -> CCAction.name.

Author: slembcke

UnitTests/CCActionTest.m

@@ -323,7 +323,6 @@ - (void)testCopyActionClearsState
     XCTAssertEqualWithAccuracy(actionCopy.elapsed, 0.0f, accuracy, @"Elapsed time was not reset.");
     XCTAssertEqualWithAccuracy(actionCopy.duration, 1.0f, accuracy, @"Duration should have been copied.");
     XCTAssertNil(actionCopy.target, @"Target not reset");
-    XCTAssertNil(actionCopy.originalTarget, @"originalTarget not reset");
 }
 
 - (void)testCopyActionClearsStateForCompletedActions
@@ -340,7 +339,6 @@ - (void)testCopyActionClearsStateForCompletedActions
     XCTAssertEqualWithAccuracy(actionCopy.elapsed, 0.0f, accuracy, @"Elapsed time was not reset.");
     XCTAssertEqualWithAccuracy(actionCopy.duration, 1.0f, accuracy, @"Duration should have been copied.");
     XCTAssertNil(actionCopy.target, @"Target not reset");
-    XCTAssertNil(actionCopy.originalTarget, @"originalTarget not reset");
 }
 
 

cocos2d-ui/CCBReader/CCAnimationManager.h

@@ -59,7 +59,7 @@
     NSMutableDictionary* _nodeSequences;
     NSMutableDictionary* _baseValues;
 
-    NSInteger _animationManagerId;
+    NSString *_animationManagerId;
     CCBSequence* _runningSequence;
     CCBSequence* _lastSequence;
 

cocos2d-ui/CCBReader/CCAnimationManager.m

@@ -29,6 +29,7 @@
 #import "CCDirector_Private.h"
 #import "CCBReader_Private.h"
 #import "CCScheduler_Private.h"
+#import "CCAction_Private.h"
 
 #import "CCBKeyframe.h"
 #import "CCBSequence.h"
@@ -66,7 +67,7 @@ - (id)init {
     self = [super init];
     if (!self) return NULL;
 
-    _animationManagerId = ccbAnimationManagerID;
+    _animationManagerId = [NSString stringWithFormat:@"%ld", (long)ccbAnimationManagerID];
     ccbAnimationManagerID++;
 
     _sequences = [[NSMutableArray alloc] init];
@@ -268,7 +269,7 @@ - (void)setAnimatedProperty:(NSString*)name forNode:(CCNode*)node toValue:(id)va
         kf1.easingType = kCCBKeyframeEasingLinear;
 
         CCActionInterval* tweenAction = [self actionFromKeyframe0:NULL andKeyframe1:kf1 propertyName:name node:node];
-        tweenAction.tag = (int)_animationManagerId;
+        tweenAction.name = _animationManagerId;
         [tweenAction startWithTarget:node];
         [_currentActions addObject:tweenAction];
     } else {
@@ -428,7 +429,7 @@ - (void)runActionsForNode:(CCNode*)node sequenceProperty:(CCBSequenceProperty*)s
     [actions addObject:nextKeyFrameBlock];
 
     CCActionSequence* seq = [CCActionSequence actionWithArray:actions];
-    seq.tag = _animationManagerId;
+    seq.name = _animationManagerId;
     [seq startWithTarget:node];
     if(kf0.time > 0) { // Ensure Sync
         [seq step:0];
@@ -569,7 +570,7 @@ - (void)addSequenceCallBacks:(int)seqId tweenDuration:(float)tweenDuration start
     CCActionSequence* completeAction = [CCActionSequence
                                         actionOne:[CCActionDelay actionWithDuration:seq.duration+tweenDuration-time]
                                         two:[CCActionCallFunc actionWithTarget:self selector:@selector(sequenceCompleted)]];
-    completeAction.tag = (int)_animationManagerId;
+    completeAction.name = _animationManagerId;
     [completeAction startWithTarget:self.rootNode];
     [_currentActions addObject:completeAction];
 
@@ -578,7 +579,7 @@ - (void)addSequenceCallBacks:(int)seqId tweenDuration:(float)tweenDuration start
         // Build sound actions for channel
         CCAction* action = [self actionForCallbackChannel:seq.callbackChannel];
         if (action) {
-            action.tag = (int)_animationManagerId;
+            action.name = _animationManagerId;;
             [action startWithTarget:self.rootNode];
             [_currentActions addObject:action];
         }
@@ -588,7 +589,7 @@ - (void)addSequenceCallBacks:(int)seqId tweenDuration:(float)tweenDuration start
         // Build sound actions for channel
         CCAction* action = [self actionForSoundChannel:seq.soundChannel];
         if (action) {
-            action.tag = (int)_animationManagerId;
+            action.name = _animationManagerId;;
             [action startWithTarget:self.rootNode];
             [_currentActions addObject:action];
         }
@@ -807,7 +808,7 @@ - (void) timeSeekForSequenceId:(int)seqId time:(float)time {
             CCActionSequence* animSequence = [CCActionSequence actions:action, nextKeyFrameBlock,nil];
 
             // Fast forward to time point
-            [animSequence setTag:_animationManagerId];
+            animSequence.name = _animationManagerId;
             [animSequence startWithTarget:node];
             [animSequence step:0]; // First Tick
             [animSequence step:timeFoward];
@@ -881,7 +882,7 @@ - (CCActionSequence*)createActionForNode:(CCNode*)node sequenceProperty:(CCBSequ
         [actions addObject:action];
 
         seq = [CCActionSequence actionWithArray:actions];
-        seq.tag = _animationManagerId;
+        seq.name = _animationManagerId;
     }
 
 

cocos2d-ui/CCScrollView.m

@@ -23,6 +23,7 @@
  */
 
 #import "ccMacros.h"
+#import "CCAction_Private.h"
 
 #if __CC_PLATFORM_IOS
 #import <UIKit/UIGestureRecognizerSubclass.h>
@@ -54,8 +55,8 @@
 #define kCCScrollViewMaxOuterDistBeforeBounceBack 50.0
 #define kCCScrollViewMinVelocityBeforeBounceBack 100.0
 
-#define kCCScrollViewActionXTag 8080
-#define kCCScrollViewActionYTag 8081
+#define CCScrollViewActionXTag @"CCScrollViewActionXTag"
+#define CCScrollViewActionYTag @"CCScrollViewActionYTag"
 
 #pragma mark -
 #pragma mark Helper classes
@@ -418,7 +419,7 @@ - (void) setScrollPosition:(CGPoint)newPos animated:(BOOL)animated
 			}] rate:2];
             CCActionCallFunc* callFunc = [CCActionCallFunc actionWithTarget:self selector:@selector(xAnimationDone)];
             action = [CCActionSequence actions:action, callFunc, nil];
-            action.tag = kCCScrollViewActionXTag;
+            action.name = CCScrollViewActionXTag;
             [self.camera runAction:action];
         }
         if (yMoved)
@@ -434,7 +435,7 @@ - (void) setScrollPosition:(CGPoint)newPos animated:(BOOL)animated
 			}] rate:2];
             CCActionCallFunc* callFunc = [CCActionCallFunc actionWithTarget:self selector:@selector(yAnimationDone)];
             action = [CCActionSequence actions:action, callFunc, nil];
-            action.tag = kCCScrollViewActionYTag;
+            action.name = CCScrollViewActionYTag;
             [self.camera runAction:action];
         }
     }
@@ -443,8 +444,8 @@ - (void) setScrollPosition:(CGPoint)newPos animated:(BOOL)animated
 #if __CC_PLATFORM_MAC
 		_lastPosition = self.scrollPosition;
 #endif
-        [self.camera stopActionByTag:kCCScrollViewActionXTag];
-        [self.camera stopActionByTag:kCCScrollViewActionYTag];
+        [self.camera stopActionByName:CCScrollViewActionXTag];
+        [self.camera stopActionByName:CCScrollViewActionYTag];
         self.camera.position = newPos;
     }
 }
@@ -638,8 +639,8 @@ - (void) touchBeganAtTranslation:(CGPoint) rawTranslation
     _startScrollPos = self.scrollPosition;
 
     _isPanning = YES;
-    [self.camera stopActionByTag:kCCScrollViewActionXTag];
-    [self.camera stopActionByTag:kCCScrollViewActionYTag];
+    [self.camera stopActionByName:CCScrollViewActionXTag];
+    [self.camera stopActionByName:CCScrollViewActionYTag];
 
 }
 

cocos2d.xcodeproj/project.pbxproj

@@ -909,6 +909,7 @@
 		D3A2E7D2181E12750033614C /* CCPhysicsShape.h in Headers */ = {isa = PBXBuildFile; fileRef = D3A2E7D0181E12750033614C /* CCPhysicsShape.h */; };
 		D3A2E7D3181E12750033614C /* CCPhysicsShape.m in Sources */ = {isa = PBXBuildFile; fileRef = D3A2E7D1181E12750033614C /* CCPhysicsShape.m */; };
 		D3BEEFA419CFE8730055B624 /* CCRendererBasicTypes.m in Sources */ = {isa = PBXBuildFile; fileRef = D34CAD6819C3A7B3009BED7A /* CCRendererBasicTypes.m */; };
+		D3D976361A896AC000462614 /* CCAction_Private.h in Headers */ = {isa = PBXBuildFile; fileRef = D3D976351A896AC000462614 /* CCAction_Private.h */; };
 		D3E3752F19CC842A0076CDBB /* CCRendererSharedTypes.h in Headers */ = {isa = PBXBuildFile; fileRef = D3E3752E19CC842A0076CDBB /* CCRendererSharedTypes.h */; };
 		E01E6D8C121F130E001A484F /* CCLabelBMFont.h in Headers */ = {isa = PBXBuildFile; fileRef = E01E6D8A121F130E001A484F /* CCLabelBMFont.h */; };
 		E01E6D8D121F130E001A484F /* CCLabelBMFont.m in Sources */ = {isa = PBXBuildFile; fileRef = E01E6D8B121F130E001A484F /* CCLabelBMFont.m */; };
@@ -1446,6 +1447,7 @@
 		D3A2E7D0181E12750033614C /* CCPhysicsShape.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CCPhysicsShape.h; sourceTree = "<group>"; };
 		D3A2E7D1181E12750033614C /* CCPhysicsShape.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CCPhysicsShape.m; sourceTree = "<group>"; };
 		D3C12815199D40AC005D2119 /* CCShaders.metal */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.metal; path = CCShaders.metal; sourceTree = "<group>"; };
+		D3D976351A896AC000462614 /* CCAction_Private.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CCAction_Private.h; sourceTree = "<group>"; };
 		D3E3752E19CC842A0076CDBB /* CCRendererSharedTypes.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CCRendererSharedTypes.h; sourceTree = "<group>"; };
 		DCF7B34D1A1D426000E0EEAF /* API-Index.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = "API-Index.md"; sourceTree = "<group>"; };
 		E01E6D8A121F130E001A484F /* CCLabelBMFont.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; lineEnding = 0; path = CCLabelBMFont.h; sourceTree = "<group>"; };
@@ -1752,6 +1754,7 @@
 			isa = PBXGroup;
 			children = (
 				5018F2520DFDEAFF00C013A5 /* CCAction.h */,
+				D3D976351A896AC000462614 /* CCAction_Private.h */,
 				5018F2530DFDEAFF00C013A5 /* CCAction.m */,
 				5018F2580DFDEAFF00C013A5 /* CCActionInstant.h */,
 				5018F2590DFDEAFF00C013A5 /* CCActionInstant.m */,
@@ -2325,6 +2328,7 @@
 				9D856721191B019900573093 /* CCEffectContrast.h in Headers */,
 				50F9E8170E1AA34E000E7616 /* ccTypes.h in Headers */,
 				D3A2E7D2181E12750033614C /* CCPhysicsShape.h in Headers */,
+				D3D976361A896AC000462614 /* CCAction_Private.h in Headers */,
 				D2AB4B411A63C7400019215E /* CCGLFence.h in Headers */,
 				D24160FD1958F6EE003673BD /* CCAnimationManager_Private.h in Headers */,
 				506602110E38A70D000B500E /* CCScheduler.h in Headers */,

cocos2d/CCAction.h

@@ -27,10 +27,6 @@
 
 #import "ccTypes.h"
 
-enum {
-	//! Default tag
-	kCCActionTagInvalid = -1,
-};
 
 /**
  CCAction is an abstract base class for all actions. Actions animate nodes by manipulating node properties over time
@@ -53,11 +49,7 @@ enum {
     - CCActionInterval
  
  */
-@interface CCAction : NSObject <NSCopying> {
-	id			__unsafe_unretained _originalTarget;
-	id			__unsafe_unretained _target;
-	NSInteger	_tag;
-}
+@interface CCAction : NSObject <NSCopying>
 
 
 
@@ -75,13 +67,6 @@ enum {
  */
 + (id)action;
 
-/**
- *  Initializes and returns an action object.
- *
- *  @return An initialized CCAction Object.
- */
-- (id)init;
-
 
 /// -----------------------------------------------------------------------
 /// @name Action Targets
@@ -91,24 +76,15 @@ enum {
  The "target" is typically the node instance that received the [CCNode runAction:] message.
  The action will modify the target properties. The target will be set with the 'startWithTarget' method.
  When the 'stop' method is called, target will be set to nil. 
- 
- @warning The target is 'assigned' (unsafe unretained), it is not 'retained' nor managed by ARC.
  */
-@property (nonatomic,readonly,unsafe_unretained) id target;
-
-/** The original target, since target can be nil. */
-@property (nonatomic,readonly,unsafe_unretained) id originalTarget;
+@property (nonatomic, readonly, unsafe_unretained) id target;
 
 /// -----------------------------------------------------------------------
 /// @name Identifying an Action
 /// -----------------------------------------------------------------------
 
-/** The action tag. An identifier of the action. */
-@property (nonatomic,readwrite,assign) NSInteger tag;
-
-// NSCopying support.
-- (id)copyWithZone:(NSZone*) zone;
-
+/** The action's name. An identifier of the action. */
+@property (nonatomic, readwrite, copy) NSString *name;
 
 /// -----------------------------------------------------------------------
 /// @name Action Methods Implemented by Subclasses
@@ -122,15 +98,14 @@ enum {
 - (BOOL)isDone;
 
 /**
- *  Assigns a target to the action
- *  Called before the action is started.
+ *  Overridden by subclasses to set up an action before it runs.
  *
- *  @param target Target to assign to action (weak reference).
+ *  @param target Target the action will run on.
  */
 - (void)startWithTarget:(id)target;
 
 /**
- *  Stops the action
+ *  Overriden by subclasses to clean up an action.
  *  Called after the action has finished. Will assign the internal target reference to nil.
  *  Note:
  *  You should never call this method directly. 
@@ -139,11 +114,11 @@ enum {
 - (void)stop;
 
 /**
- *  Steps the action.
- *  Called for every frame with step interval.
+ *  Overridden by subclasses to update the target.
+ *  Called every frame with the time delta.
  *
  *  Note:
- *  Do not override unless you know what you are doing.
+ *  Do not call this method directly. Actions are automatically stepped when used with [CCNode runAction:].
  *
  *  @param dt Ellapsed interval since last step.
  */
@@ -177,15 +152,12 @@ enum {
  - CCActionInterval
 
 */
-@interface CCActionFiniteTime : CCAction <NSCopying> {
-	// Duration in seconds.
-	CCTime _duration;
-}
+@interface CCActionFiniteTime : CCAction
 
 /** @name Duration */
 
 /** Duration of the action in seconds. */
-@property (nonatomic,readwrite) CCTime duration;
+@property (nonatomic, readwrite) CCTime duration;
 
 /** @name Reversing an Action */
 
@@ -211,9 +183,7 @@ enum {
  *  @note This action can not be used within a CCActionSequence because it is not an CCActionInterval action.
  *  However you can use CCActionRepeatForever to repeat a CCActionSequence.
  */
-@interface CCActionRepeatForever : CCAction <NSCopying> {
-	CCActionInterval *_innerAction;
-}
+@interface CCActionRepeatForever : CCAction
 
 // purposefully undocumented: user does not need to access inner action
 /* Inner action. */
@@ -283,10 +253,7 @@ enum {
  @note CCActionSpeed can not be added to a CCActionSequence because it does not inherit from CCActionFiniteTime.
  It can however be used to control the speed of an entire CCActionSequence.
  */
-@interface CCActionSpeed : CCAction <NSCopying> {
-	CCActionInterval	*_innerAction;
-	CGFloat _speed;
-}
+@interface CCActionSpeed : CCAction
 
 /// -----------------------------------------------------------------------
 /// @name Creating a Speed Action
@@ -356,27 +323,7 @@ enum {
  Whenever `playerNode` changes its position, the position of `gameLayerNode` will be updated (moved in the opposite direction)
  to keep `playerNode` centered.
  */
-@interface CCActionFollow : CCAction <NSCopying> {
-    
-	// Node to follow.
-	CCNode	*_followedNode;
-
-	// Whether camera should be limited to certain area.
-	BOOL _boundarySet;
-
-	// If screen-size is bigger than the boundary - update not needed.
-	BOOL _boundaryFullyCovered;
-
-	// Fast access to the screen dimensions.
-	CGPoint _halfScreenSize;
-	CGPoint _fullScreenSize;
-
-	// World boundaries.
-	float _leftBoundary;
-	float _rightBoundary;
-	float _topBoundary;
-	float _bottomBoundary;
-}
+@interface CCActionFollow : CCAction
 
 /// -----------------------------------------------------------------------
 /// @name Creating a Follow Action