Home > Articles > Programming > General Programming/Other Languages

Learning Cocos2D: Simple Collision Detection and Enemy AI

📄 Contents

  1. Creating the Radar Dish and Viking Classes
  2. Creating the Viking Class
  3. Final Steps
  4. Summary
  5. Challenges
  • Print
  • + Share This
This chapter shows how to implement a simple system for collision detection and the artificial intelligence brain of the enemies in a sample game.
This chapter is from the book

In the previous chapter you learned the basics of Cocos2D animations and actions. You also started building a flexible framework for Space Viking. In this chapter you go further and create the first enemy for Ole to do battle with. In the process you learn how to implement a simple system for collision detection and the artificial intelligence brain of the enemies in Space Viking.

There is a significant amount of code necessary in this chapter to drive the behavior of Ole and the RadarDish. Take your time understanding how these classes work, as they are the foundation and models for the rest of the classes in Space Viking.

Ready to defeat the aliens?

Creating the Radar Dish and Viking Classes

From just a CCSprite to a fully animated character, Ole the Viking takes the plunge from simple to advanced from here on out. In this section you create the RadarDish and Viking classes to encapsulate the logic needed by each, including all of the animations. The RadarDish class is worth a close look, as all of the enemy characters in Space Viking are modeled after it.

Creating the RadarDish Class

In this first scene, there is a suspicious radar dish on the right side of the screen. It scans for foreign creatures such as Ole. Ole needs to find a way to destroy the radar dish before it alerts the enemy robots of his presence. Fortunately, Ole knows two ways to deal with such problems: his left and right fists. Create the new RadarDish class in Xcode by following these steps:

  1. In Xcode, right-click on the EnemyObjects group.
  2. Select New File, choose the Cocoa Touch category under iOS and Objective-C class as the file type, and click Next.
  3. For the Subclass field, enter GameCharacter and click Next.
  4. Enter RadarDish for the filename and click Finish.

Open the RadarDish.h header file and change the contents to match the code in Listing 4.1.

Listing 4.1. RadarDish.h header file

//  RadarDish.h
//  SpaceViking
//
#import <Foundation/Foundation.h>
#import "GameCharacter.h"

@interface RadarDish : GameCharacter {
    CCAnimation *tiltingAnim;
    CCAnimation *transmittingAnim;
    CCAnimation *takingAHitAnim;
    CCAnimation *blowingUpAnim;
    GameCharacter *vikingCharacter;

}
@property (nonatomic, retain) CCAnimation *tiltingAnim;
@property (nonatomic, retain) CCAnimation *transmittingAnim;
@property (nonatomic, retain) CCAnimation *takingAHitAnim;
@property (nonatomic, retain) CCAnimation *blowingUpAnim;

@end

Looking at Listing 4.1 you can see that the RadarDish class inherits from the GameCharacter class and that it defines four CCAnimation instance variables. There is also an instance variable to hold a pointer back to the Viking character.

Listings 4.2, 4.3, and 4.4 show the contents of the RadarDish.m implementation file. The changeState and updateStateWithDelta time methods are crucial to understand, as they are the most basic versions of what you will find in all of the characters in Space Viking. While reading this code, keep in mind that the RadarDish is a simple enemy that never moves or attacks the Viking. The RadarDish does take damage from the Viking, eventually blowing up by moving to a dead state. Listing 4.2 covers the top portion of the RadarDish.m implementation file, including the changeState method. Open the RadarDish.m implementation file and replace the code so that it matches the contents in Listings 4.2, 4.3, and 4.4.

Listing 4.2. RadarDish.m implementation file (top portion)

//  RadarDish.m
//  SpaceViking
#import "RadarDish.h"

@implementation RadarDish
@synthesize tiltingAnim;
@synthesize transmittingAnim;
@synthesize takingAHitAnim;
@synthesize blowingUpAnim;

- (void) dealloc{
    [tiltingAnim release];
    [transmittingAnim release];
    [takingAHitAnim release];
    [blowingUpAnim release];
    [super dealloc];
}

-(void)changeState:(CharacterStates)newState {
    [self stopAllActions];
    id action = nil;
    [self setCharacterState:newState];

    switch (newState) {
        case kStateSpawning:
            CCLOG(@"RadarDish->Starting the Spawning Animation");
            action = [CCAnimate actionWithAnimation:tiltingAnim
                               restoreOriginalFrame:NO];
            break;

        case kStateIdle:
            CCLOG(@"RadarDish->Changing State to Idle");
            action = [CCAnimate actionWithAnimation:transmittingAnim
                               restoreOriginalFrame:NO];
            break;

        case kStateTakingDamage:
            CCLOG(@"RadarDish->Changing State to TakingDamage");
            characterHealth =
             characterHealth - [vikingCharacter getWeaponDamage];
            if (characterHealth <= 0.0f) {
                [self changeState:kStateDead];
            } else {
                action = [CCAnimate actionWithAnimation:takingAHitAnim
                                   restoreOriginalFrame:NO];
            }
            break;

        case kStateDead:
            CCLOG(@"RadarDish->Changing State to Dead");
            action = [CCAnimate actionWithAnimation:blowingUpAnim
                               restoreOriginalFrame:NO];
            break;

        default:
            CCLOG(@"Unhandled state %d in RadarDish", newState);
            break;
    }
    if (action != nil) {
        [self runAction:action];
    }
}

The changeState method is called when the RadarDish needs to transition between states. In the beginning of this chapter you were introduced to state machines, and the changeState method is what allows for transitions to different states in the miniscule "brain" of the RadarDish. The RadarDish brain can exist in one of four states: spawning, idle, taking damage, or dead. In the listings that follow, you will see that the RadarDish is initialized in the spawning state when it is created, and then through the updateStateWithDeltaTime method it will move through the four states.

When the updateStateWithDeltaTime determines that the RadarDish needs to change its state, the changeState method is called. Looking at Listing 4.2, you can recap what the switch state is doing as follows:

  • Spawning (kStateSpawning)

    Starts up the RadarDish with the tilting animation, which is the dish moving up and down.

  • Idle (kStateIdle)

    Runs the transmitting animation, which is the RadarDish blinking.

  • Taking Damage (kStateTakingDamage)

    Runs the taking damage animation, showing a hit to the RadarDish. The RadarDish health is reduced according to the type of weapon being used against it.

  • Dead (kStateDead)

The RadarDish plays a death animation of it blowing up. This state occurs once the RadarDish health is at or below zero.

The next section of the RadarDish implementation file is covered in Listing 4.3, showing the updateStateWithDeltaTime method.

Listing 4.3. RadarDish.m implementation file (middle portion)

-(void)updateStateWithDeltaTime:(ccTime)deltaTime
andListOfGameObjects:(CCArray*)listOfGameObjects {
    if (characterState == kStateDead)
        return;                                                    // 1

    vikingCharacter =
    (GameCharacter*)[[self parent]
      getChildByTag:kVikingSpriteTagValue];                        // 2

    CGRect vikingBoudingBox =
            [vikingCharacter adjustedBoundingBox];                 // 3
    CharacterStates vikingState = [vikingCharacter
                                   characterState];                // 4

    // Calculate if the Viking is attacking and nearby
    if ((vikingState == kStateAttacking) &&
        (CGRectIntersectsRect([self adjustedBoundingBox],
vikingBoudingBox))) {                                              // 5
        if (characterState != kStateTakingDamage) {
            // If RadarDish is NOT already taking Damage
            [self changeState:kStateTakingDamage];
            return;
        }
    }

    if (([self numberOfRunningActions] == 0) &&
        (characterState != kStateDead)) {
        CCLOG(@"Going to Idle");
        [self changeState:kStateIdle];                           // 6
        return;
    }
}

Now let's examine the numbered lines of the code:

  1. Checks if the RadarDish is already dead. If it is, this method is short-circuited and returned. If the RadarDish is dead, there is nothing to update.
  2. Gets the Viking character object from the RadarDish parent. All of Space Viking's objects are children of the scene SpriteBatchNode, referred to here as the parent. The Viking in particular was added to the SpriteBatchNode with a particular tag, referred to by the constant kVikingSpriteTagValue. By obtaining a reference to the Viking object, the RadarDish can determine if the Viking is nearby and attacking the RadarDish. (Listing 4.3 contains the code that sets up the kVikingSpriteTagValue constant.)
  3. Gets the Viking character's adjusted bounding box.
  4. Gets the Viking character's state.
  5. Determines if the Viking is nearby and attacking. If the adjusted bounding boxes for the Viking and the RadarDish overlap, and the Viking is in his attack phase, the RadarDish can be certain that the Viking is attacking it. The call to changeState:kStateTakingDamage will alter the RadarDish animation to reflect the attack and reduce the RadarDish character's health.
  6. Resets the transmission animation on the RadarDish. If the RadarDish is not currently playing an animation, and it is not dead, it is reset to idle so that the transmission animation can restart.

The last part of the RadarDish.m implementation file is the longest but least complicated. There is an initAnimations method, which sets up all of the RadarDish animations, and an init method that initializes the RadarDish and sets up the starting values for the instance variables. Add the contents of Listing 4.4 to your RadarDish.m implementation file.

Listing 4.4. RadarDish.m implementation file (bottom portion)

-(void)initAnimations {
    [self setTiltingAnim:
     [self loadPlistForAnimationWithName:@"tiltingAnim"
      andClassName:NSStringFromClass([self class])]];

    [self setTransmittingAnim:
     [self loadPlistForAnimationWithName:@"transmittingAnim"
      andClassName:NSStringFromClass([self class])]];

    [self setTakingAHitAnim:
     [self loadPlistForAnimationWithName:@"takingAHitAnim"
      andClassName:NSStringFromClass([self class])]];

    [self setBlowingUpAnim:
     [self loadPlistForAnimationWithName:@"blowingUpAnim"
      andClassName:NSStringFromClass([self class])]];
}
-(id) init {
    if( (self=[super init]) ) {
        CCLOG(@"### RadarDish initialized");
        [self initAnimations];                                   // 1
        characterHealth = 100.0f;                                // 2
        gameObjectType = kEnemyTypeRadarDish;                    // 3
        [self changeState:kStateSpawning];                       // 4
    }
    return self;
}
@end

The initAnimations method calls the loadPlistForAnimationWithName method you declared in the GameObject class. The name of the animation to load is passed along with the class name. Note the convenience method NSStringFromClass is used to get an NSString from the class name, in this case RadarDish. The class name is used to find the correct plist file for the object, since the plist files have a name corresponding to the class. The following occurs in the init method:

  1. Calls the initAnimations method, which sets up all of the animations for the RadarDish. The frame's coordinates and textures were already loaded and cached by Cocos2D when the texture atlas files (scene1atlas.png and scene1atlas.plist) were loaded by the GameplayLayer class.
  2. Sets the initial health of the RadarDish to a value of 100.
  3. Sets the RadarDish to be a Game Object of type kEnemyTypeRadarDish.
  4. Initializes the state of the RadarDish to spawning. Looking back at Listing 4.2, you can see that this starts the tilting animation, which is followed by the transmitting animation when the RadarDish moves from spawning to an idle state.

There is a little more work left before you can have this chapter's game running on your device. You need to add the Viking class and make some changes to the GameplayLayer class. It is important to understand how the updateStateWithDeltaTime and the changeState methods in RadarDish control the state of the AI brain. These same two methods are used to drive the brain of all of the other game characters, including Ole the Viking.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020