## Jedi Knight COG Script
#
# 00_different_jkendlevels.COG
#
#   This COG Script caters for various types of endings
#   for a jk level.
#
# Set verbose=1, if you want to see print out messages.
# (More for test purposes than anything else...)
#
# This COG script is NOT supported by LucasArts or LEC.
#
# Permission is granted to use this script by the author, as long as credit
# is provided in the readme file for any add-on levels that use this script.
#
# Revised: 26-Aug-2003
#
#
# (c) Richard John Sproston 2001
# E-mail: lucky_jackpot@hotmail.com
# [RJS]
#
##

#...........................................................................................
#...........................................................................................
#...........................................................................................

SYMBOLS

    message entered
    message exited
    message activated
    message touched
    message taken
    message crossed
    message killed


    sector  enter_sector  linkid=1  # Works with "entered" msg,
                                             # (when player enters a specific sector).

    sector  exit_sector    linkid=2  # Works with "exited" msg,
                                             # (when player leaves a specific sector).

    surface switch01       linkid=3  # Use if you want to have the player
                                             # press a switch to end the level.

    surface tread_surf     linkid=4  # A Surface which ends the level
                                             # when the player steps on it.

    thing   item1             linkid=5 # Used if an item needs to be collected
                                             # to end level.

    thing   touched_thing linkid=6 # Used if a player needs to be
                                             # touched "t-e-l".

    thing   activated_thing linkid=7 # If a player needs to activate
                                              # a thing "t-e-l".

    thing   killed_thing      linkid=8  # Used if the player needs to
                                              # kill a thing "t-e-l".

    int     protectMode=0            # Used in conjunction with linkid=8;
                                             # Set to 0, then you must KILL "killed_thing"
                                             # to COMPLETE mission.
                                             #
                                             # Set to 1 then you must PROTECT
                                             # "killed_thing", otherwise you FAIL mission
                                             # if they die.

    thing   enterSector_thing   linkid=9  # Use if a thing enters a specifc sector
                                                    # Used in conjunction with linkid=1

    sound completed=accomplish1.wav
    sound failed

    flex    sleepBeforeEndLevel
    int     verbose=0

END

#...........................................................................................
#...........................................................................................
#...........................................................................................

CODE

#...........................................................................................

entered:

    if ( (GetSenderID() != 1) || (GetSenderID() != 9) )
        return;

    if (GetSenderID() == 1) {
        if (GetSourceRef() == GetLocalPlayerThing() ) {
            if (verbose)
            Print ("Sender ID's match - end level");
            call level_ends_now;    // Successful...
        }
        else
        if (GetSourceRef() == enterSector_thing) {
            if (verbose)
            Print ("Thing entered the trigger sector, before player could stop it - MISSION FAILED");
            JkEndLevel (0); // Fail Mission
        }
    }

    return;

#...........................................................................................

exited:

    if (GetSenderID() != 2)
        return;

    if (GetSenderID() == 2) {
        if (verbose)
        Print ("Sender ID's match - end level");
        call level_ends_now;
    }

    return;

#...........................................................................................

activated:

    if ( (GetSenderID() !=3) || (GetSenderID() != 7) )
        return;


    if (GetSenderID () == 3) {
        if (verbose)
        Print ("ID Match: 3 --- This is surface 'switch01' ...");
        call level_ends_now;
    }

    if (GetSenderID() == 7) {
        if (verbose)
        Print ("ID Match: 7 --- This is an activated thing - console, player etc");
        call level_ends_now;
    }

    return;

#...........................................................................................

taken:

    if (GetSenderRef() != item1) {  // Return to game if the item
        return;                             // was not the sender of the msg.
    }


        // If the message sender was the item, then continue....
    if (GetSenderRef() == item1) {
        if (verbose)
        Print ("Item has been touched - prepare for remove, if criteria fits...");

            // Return to game, if the person who touched the item, was NOT the player...
        if (GetSourceRef() != GetLocalPlayerThing() ) {
            if (verbose)
            Print ("Item touched, but not taken - only player can take the item...");
            return;
        }

            // If the check has passed, then proceed to the custom function call...
        call level_ends_now;
    }

    return;

#...........................................................................................

touched:

    if ( (GetSenderID() != 5) || (GetSenderID() != 6) )
        return;


    if (GetSenderID() == 5) {
        if (verbose)
        Print ("Sender ID Match: 5 --- item thing has been touched");
        call level_ends_now;
    }

    if (GetSenderID() == 6) {
        if (verbose)
        Print ("Sender ID Match: 6 --- thing console, elev, actor, etc");
        call level_ends_now;
    }

    return;

#...........................................................................................

crossed:

    if (GetSenderID() != 4)
        return;

    if (GetSenderRef() == tread_surf) {
        if (verbose)
        Print ("An end-level surface has been touched...");
        call level_ends_now;
    }

    return;


#...........................................................................................

killed:

        // If "killed_thing" thing is killed...
    if (GetSenderID() == 8) {
        if (protectMode == 0) {     // MUST KILL A PERSON !!!
            if (verbose)
            Print ("Target has been killed - Mission Completed Succesfully");
            PlaySoundLocal (completed, 1, 0, 0x0);
            call level_ends_now;
        }
        else
        if (protectMode == 1) {     // MUST STOP A PERSON BEING KILLED !!!
            if (verbose)
            Print ("The person you were meant to protect has died: Mission Failed...");
            PlaySoundLocal (failed, 1, 0, 0x0);
            JKEndLevel (0);     // End in a failure...
        }
    }

    return;

#...........................................................................................


level_ends_now:

    sleep (sleepBeforeEndLevel);
    JkEndLevel (1); // Mission successful

    return;

#...........................................................................................

end