Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Jailbreak.JBInfoJail


00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00049
00050
00051
00052
00053
00054
00055
00056
00057
00058
00059
00060
00061
00062
00063
00064
00065
00066
00067
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089
00090
00091
00092
00093
00094
00095
00096
00097
00098
00099
00100
00101
00102
00103
00104
00105
00106
00107
00108
00109
00110
00111
00112
00113
00114
00115
00116
00117
00118
00119
00120
00121
00122
00123
00124
00125
00126
00127
00128
00129
00130
00131
00132
00133
00134
00135
00136
00137
00138
00139
00140
00141
00142
00143
00144
00145
00146
00147
00148
00149
00150
00151
00152
00153
00154
00155
00156
00157
00158
00159
00160
00161
00162
00163
00164
00165
00166
00167
00168
00169
00170
00171
00172
00173
00174
00175
00176
00177
00178
00179
00180
00181
00182
00183
00184
00185
00186
00187
00188
00189
00190
00191
00192
00193
00194
00195
00196
00197
00198
00199
00200
00201
00202
00203
00204
00205
00206
00207
00208
00209
00210
00211
00212
00213
00214
00215
00216
00217
00218
00219
00220
00221
00222
00223
00224
00225
00226
00227
00228
00229
00230
00231
00232
00233
00234
00235
00236
00237
00238
00239
00240
00241
00242
00243
00244
00245
00246
00247
00248
00249
00250
00251
00252
00253
00254
00255
00256
00257
00258
00259
00260
00261
00262
00263
00264
00265
00266
00267
00268
00269
00270
00271
00272
00273
00274
00275
00276
00277
00278
00279
00280
00281
00282
00283
00284
00285
00286
00287
00288
00289
00290
00291
00292
00293
00294
00295
00296
00297
00298
00299
00300
00301
00302
00303
00304
00305
00306
00307
00308
00309
00310
00311
00312
00313
00314
00315
00316
00317
00318
00319
00320
00321
00322
00323
00324
00325
00326
00327
00328
00329
00330
00331
00332
00333
00334
00335
00336
00337
00338
00339
00340
00341
00342
00343
00344
00345
00346
00347
00348
00349
00350
00351
00352
00353
00354
00355
00356
00357
00358
00359
00360
00361
00362
00363
00364
00365
00366
00367
00368
00369
00370
00371
00372
00373
00374
00375
00376
00377
00378
00379
00380
00381
00382
00383
00384
00385
00386
00387
00388
00389
00390
00391
00392
00393
00394
00395
00396
00397
00398
00399
00400
00401
00402
00403
00404
00405
00406
00407
00408
00409
00410
00411
00412
00413
00414
00415
00416
00417
00418
00419
00420
00421
00422
00423
00424
00425
00426
00427
00428
00429
00430
00431
00432
00433
00434
00435
00436
00437
00438
00439
00440
00441
00442
00443
00444
00445
00446
00447
00448
00449
00450
00451
00452
00453
00454
00455
00456
00457
00458
00459
00460
00461
00462
00463
00464
00465
00466
00467
00468
00469
00470
00471
00472
00473
00474
00475
00476
00477
00478
00479
00480
00481
00482
00483
00484
00485
00486
00487
00488
00489
00490
00491
00492
00493
00494
00495
00496
00497
00498
00499
00500
00501
00502
00503
00504
00505
00506
00507
00508
00509
00510
00511
00512
00513
00514
00515
00516
00517
00518
00519
00520
00521
00522
00523
00524
00525
00526
00527
00528
00529
00530
00531
00532
00533
00534
00535
00536
00537
00538
00539
00540
00541
00542
00543
00544
00545
00546
00547
00548
00549
00550
00551
00552
00553
00554
00555
00556
00557
00558
00559
00560
00561
00562
00563
00564
00565
00566
00567
00568
00569
00570
00571
00572
00573
00574
00575
00576
00577
00578
00579
00580
00581
00582
00583
00584
00585
00586
00587
00588
00589
00590
00591
00592
00593
00594
00595
00596
00597
00598
00599
00600
00601
00602
00603
00604
00605
00606
00607
00608
00609
00610
00611
00612
00613
00614
00615
00616
00617
00618
00619
00620
00621
00622
00623
00624
00625
00626
00627
00628
00629
00630
00631
00632
00633
00634
00635
00636
00637
00638
00639
00640
00641
00642
00643
00644
00645
00646
00647
00648
00649
00650
00651
00652
00653
00654
00655
00656
00657
00658
00659
00660
00661
00662
00663
00664
00665
00666
00667
00668
00669
00670
00671
00672
00673
00674
00675
00676
00677
00678
00679
00680
00681
00682
00683
00684
00685
00686
00687
00688
00689
00690
00691
00692
00693
00694
00695
00696
00697
00698
00699
00700
00701
00702
00703
00704
00705
00706
00707
00708
00709
00710
00711
00712
00713
00714
00715
00716
00717
00718
00719
00720
00721
00722
00723
00724
00725
00726
00727
00728
00729
00730
00731
00732
00733
00734
00735
00736
00737
00738
00739
00740
00741
00742
00743
00744
00745
00746
00747
00748
00749
00750
00751
00752
00753
00754
00755
00756
00757
00758
00759
00760
00761
00762
00763
00764
00765
00766
00767
00768
00769
00770
00771
00772
00773
00774
00775
00776
00777
00778
00779
00780
00781
00782
00783
00784
00785
00786
00787
00788
00789
00790
00791
00792
00793
00794
00795
00796
00797
00798
00799
00800
00801
00802
00803
00804
00805
00806
00807
00808
00809
00810
00811
00812
00813
00814
00815
00816
00817
00818
00819
00820
00821
00822
00823
00824
00825
00826
00827
00828
00829
00830
00831
00832
00833
00834
00835
00836
00837
00838
00839
00840
00841
00842
00843
00844
00845
00846
00847
00848
00849
00850
00851
00852
00853
00854
00855
00856
00857
00858
00859
00860
00861
00862
00863
00864
00865
00866
00867
00868
00869
00870
00871
00872
00873
00874
00875
00876
00877
00878
00879
00880
00881
00882
00883
00884
00885
00886
00887
00888
00889
00890
00891
00892
00893
00894
00895
00896
00897
00898
00899
00900
00901
00902
00903
00904
00905
00906
00907
00908
00909
00910
00911
00912
00913
00914
00915
00916
00917
00918
00919
00920
00921
00922
00923
00924
00925
00926
00927
00928
00929
00930
00931
00932
00933
00934
00935
00936
00937
00938
00939
00940
00941
00942
00943
00944
00945
00946
00947
00948
00949
00950
00951
00952
00953
00954
00955
00956
00957
00958
00959
00960
00961
00962
00963
00964
00965
00966
00967
00968
00969
00970
00971
00972
00973
00974
00975
00976
00977
00978
00979
00980
00981
00982
00983
00984
00985
00986
00987
00988
00989
00990
00991
00992
00993
00994
00995
00996
00997
00998
00999
01000
01001
01002
01003
01004
01005
01006
01007
01008
01009
01010
01011
01012
01013
01014
01015
01016
01017
01018
01019
01020
01021
01022
01023
01024
01025
01026
01027
01028
01029
01030
01031
01032
01033
01034
01035
01036
01037
01038
01039
01040
01041
01042
01043
01044
01045
01046
01047
01048
01049
01050
01051
01052
01053
01054
01055
01056
01057
01058
01059
01060
01061
01062
01063
01064
01065
01066
01067
01068
01069
01070
01071
01072
01073
01074
01075
01076
01077
01078
01079
01080
01081
01082
01083
01084
01085
01086
01087
01088
01089
01090
01091
01092
01093
01094
01095
01096
01097
01098
01099
01100
01101
01102
01103
01104
01105
01106
01107
01108
01109
01110
01111
01112
01113
01114
01115
01116
01117
01118
01119
01120
01121
01122
01123
01124
01125
01126
01127
01128
01129
01130
01131
01132
01133
01134
01135
01136
01137
01138
01139
01140
01141
01142
01143
01144
01145
01146
01147
01148
01149
01150
01151
01152
01153
01154
01155
01156
01157
01158
01159
01160
01161
01162
01163
01164
01165
01166
01167
01168
01169
01170
01171
01172
01173
01174
01175
01176
01177
01178
01179
01180
01181
01182
01183
01184
01185
01186
01187
01188
01189
01190
01191
01192
01193
01194
01195
01196
01197
01198
01199
01200
01201
01202
01203
01204
01205
01206
01207
01208
01209
01210
01211
01212
01213
01214
01215
01216
01217
01218
01219
01220
01221
01222
01223
01224
01225
01226
01227
01228
01229
01230
01231
01232
01233
01234
01235
01236
01237
01238
01239
01240
01241
01242
01243
01244
01245
01246
01247
01248
01249
01250
// ============================================================================
// JBInfoJail
// Copyright 2002 by Mychaeel <mychaeel@planetjailbreak.com>
// $Id: JBInfoJail.uc,v 1.54 2011-07-16 09:19:32 wormbo Exp $
//
// Holds information about a generic jail.
// ============================================================================


class JBInfoJail extends Info
  placeable;


// ============================================================================
// Imports
// ============================================================================

#exec texture import file=Textures\JBInfoJail.pcx mips=off masked=on


// ============================================================================
// Properties
// ============================================================================

var(Events) name EventExecutionInit;     // event fired when camera activated
var(Events) name EventExecutionCommit;   // event fired when execution starts
var(Events) name EventExecutionEnd;      // event fired when execution finished
var(Events) name EventReleaseRed;        // event fired to release red team
var(Events) name EventReleaseBlue;       // event fired to release blue team
var(Events) name EventFinalExecutionInit;   // only fired when it's the final execution
var(Events) name EventFinalExecutionCommit; // only fired when it's the final execution
var(Events) name EventFinalExecutionEnd;    // only fired when it's the final execution

var() float ExecutionDelayCommit;        // delay between camera and execution
var() float ExecutionDelayFallback;      // delay between execution and gibbing
var() float FinalExecutionDelayCommit;   // delay between camera and execution
var() float FinalExecutionDelayFallback; // delay between execution and gibbing

var() byte Priority;                     // prisoners will spawn in the jail with the lowest priority
var() byte PrisonerLimit;                // prisoners won't be spawned in jails where the limit is reached

var() name TagAttachVolumes;             // tag of attached volumes
var() name TagAttachZones;               // tag of attached zones


// ============================================================================
// Types
// ============================================================================

struct TInfoRelease
{
  var bool bIsOpening;                  // release doors are opening
  var float TimeActivation;             // time of release activation
  var float TimeReset;                  // time of release switch reset
  var Controller ControllerInstigator;  // player activating the release
  var array<Mover> ListMover;           // movers opening for this event
};


// ============================================================================
// Variables
// ============================================================================

var JBInfoJail nextJail;

var private TInfoRelease InfoReleaseByTeam[2];  // release state for each team
var private array<Volume> ListVolume;           // volumes attached to jail
var private array<NavigationPoint> ListNavigationPointExit;  // exit points

var private bool bIsRedActive;
var private bool bIsBlueActive;
var private bool bRedJammed;                   // red can't be released
var private bool bBlueJammed;                  // blue can't be released
var private bool bForcedReleaseRed;            // red can be released even if it's jammed
var private bool bForcedReleaseBlue;           // blue can be released even if it's jammed
var private bool bIsFinalExecution;            // final execution is running


// ============================================================================
// Replication
// ============================================================================

replication
{
  reliable if(Role == ROLE_Authority)
    bIsRedActive, bIsBlueActive, bRedJammed, bBlueJammed;
}


// ============================================================================
// PostBeginPlay
//
// Initializes the ListVolume array with references to all volumes attached to
// this jail, and the ListMover arrays with references to all movers that are
// opened by release events.
// ============================================================================

event PostBeginPlay()
{
  local Volume thisVolume;
  local PlayerStart thisStart;

  if (TagAttachVolumes != '' &&
      TagAttachVolumes != 'None')
    foreach AllActors(Class'Volume', thisVolume, TagAttachVolumes)
      ListVolume[ListVolume.Length] = thisVolume;

  FindReleases(EventReleaseRed,  InfoReleaseByTeam[0].ListMover);
  FindReleases(EventReleaseBlue, InfoReleaseByTeam[1].ListMover);

  if (Jailbreak(Level.Game) == None) {
    foreach AllActors(class'PlayerStart', thisStart) {
      if (ContainsActor(thisStart))
        thisStart.bEnabled = False;
    }
  }
}


// ============================================================================
// Tick
//
// If this JBInfoJail actor is not yet registered in the global JBInfoJail
// linked list client-side yet, adds it to it.
// ============================================================================

simulated event Tick(float TimeDelta)
{
  local JBInfoJail firstJail;
  local JBInfoJail thisJail;
  local JBGameReplicationInfo InfoGame;

  if (Role < ROLE_Authority) {
    InfoGame = JBGameReplicationInfo(Level.GetLocalPlayerController().GameReplicationInfo);
    if (InfoGame == None)
      return;

    firstJail = InfoGame.firstJail;
    for (thisJail = firstJail; thisJail != None; thisJail = thisJail.nextJail)
      if (thisJail == Self)
        return;

    nextJail = InfoGame.firstJail;
    InfoGame.firstJail = Self;
  }

  Disable('Tick');
}


// ============================================================================
// FindReleases
//
// Adds movers triggered by the given tag to the given array unless they are
// present there already. Then recursively finds other movers triggered by the
// found mover's OpeningEvent and adds them too.
// ============================================================================

function FindReleases(name TagMover, out array<Mover> ListMover)
{
  local int iMover;
  local Mover thisMover;

  if (TagMover == '' ||
      TagMover == 'None')
    return;

  foreach DynamicActors(Class'Mover', thisMover, TagMover) {
    for (iMover = 0; iMover < ListMover.Length; iMover++)
      if (ListMover[iMover] == thisMover)
        break;

    if (iMover < ListMover.Length)
      continue;  // mover already listed

    ListMover[iMover] = thisMover;

    FindReleases(thisMover.Event,        ListMover);
    FindReleases(thisMover.OpeningEvent, ListMover);
    FindReleases(thisMover.OpenedEvent,  ListMover);
    FindReleases(thisMover.ClosingEvent, ListMover);
  }
}


// ============================================================================
// FindExits
//
// Finds and returns a list of NavigationPoint actors outside jail that are
// directly connected to NavigationPoint actors in this jail. If multiple
// paths lead from a point in jail to one outside, this exit will be listed
// multiple times.
// ============================================================================

function array<NavigationPoint> FindExits()
{
  local int iReachSpec;
  local NavigationPoint thisNavigationPoint;

  if (ListNavigationPointExit.Length == 0)
    for (thisNavigationPoint = Level.NavigationPointList;
         thisNavigationPoint != None;
         thisNavigationPoint = thisNavigationPoint.nextNavigationPoint)
      if (ContainsActor(thisNavigationPoint))
        for (iReachSpec = 0; iReachSpec < thisNavigationPoint.PathList.Length; iReachSpec++)
          if (!Jailbreak(Level.Game).ContainsActorArena(thisNavigationPoint.PathList[iReachSpec].End) &&
              !Jailbreak(Level.Game).ContainsActorJail (thisNavigationPoint.PathList[iReachSpec].End))
            ListNavigationPointExit[ListNavigationPointExit.Length] = thisNavigationPoint.PathList[iReachSpec].End;

  return ListNavigationPointExit;
}


// ============================================================================
// CanReleaseTeam
//
// Checks whether this jail can release players of the given team.
// ============================================================================

function bool CanReleaseTeam(TeamInfo Team)
{
  local Actor thisActor;

  if (GetEventRelease(Team) == '')
    return False;

  foreach DynamicActors(Class'Actor', thisActor, GetEventRelease(Team))
    return True;

  return False;
}


// ============================================================================
// CanReleaseBy
//
// Checks and returns whether the given player can trigger a release for the
// given team.
// ============================================================================

function bool CanReleaseBy(Controller Controller, TeamInfo Team)
{
  local JBTagPlayer TagPlayer;

  if (Controller                       == None ||
      Controller.PlayerReplicationInfo == None)
    return False;

  if (      Controller.Pawn  == None ||
      xPawn(Controller.Pawn) == None)
    return False;

  TagPlayer = Class'JBTagPlayer'.Static.FindFor(Controller.PlayerReplicationInfo);
  return (TagPlayer != None &&
          TagPlayer.IsFree() &&
         !IsJammed(Team.TeamIndex));
}


// ============================================================================
// GetEventRelease
//
// Returns the value of EventReleaseRed or EventReleaseBlue depending on the
// given team index.
// ============================================================================

function name GetEventRelease(TeamInfo Team)
{
  switch (Team.TeamIndex) {
    case 0:  return EventReleaseRed;
    case 1:  return EventReleaseBlue;
  }
}


// ============================================================================
// IsReleaseMoverOpen
//
// Checks and returns whether any release movers of this jail for the given
// team are currently fully open.
// ============================================================================

function bool IsReleaseMoverOpen(TeamInfo Team)
{
  local int iMover;
  local TInfoRelease InfoRelease;

  InfoRelease = InfoReleaseByTeam[Team.TeamIndex];

  for (iMover = 0; iMover < InfoRelease.ListMover.Length; iMover++)
    if (!InfoRelease.ListMover[iMover].bClosed &&
        !InfoRelease.ListMover[iMover].bInterpolating)
      return True;  // neither closed nor interpolating, thus open

  return False;
}


// ============================================================================
// IsReleaseMoverClosed
//
// Checks and returns whether all release movers of this jail for the given
// team are fully closed.
// ============================================================================

function bool IsReleaseMoverClosed(TeamInfo Team)
{
  local int iMover;
  local TInfoRelease InfoRelease;

  InfoRelease = InfoReleaseByTeam[Team.TeamIndex];

  for (iMover = 0; iMover < InfoRelease.ListMover.Length; iMover++)
    if (!InfoRelease.ListMover[iMover].bClosed)
      return False;

  return True;
}


// ============================================================================
// ContainsActor
//
// Returns whether this jail (including attached zones and volumes) contains
// the given actor. Note that this is a physical relationship, not a logical
// one; a player who's physically located in jail isn't necessarily a prisoner.
// Use the IsInJail function in JBTagPlayer to check the latter.
// ============================================================================

function bool ContainsActor(Actor Actor)
{
  local int iVolume;

  if (Actor == None)
    return False;

  if (TagAttachZones == 'auto') {
    if (Actor.Region.ZoneNumber == Region.ZoneNumber)
      return True;
  }
  else {
    if (Actor.Region.Zone.Tag == TagAttachZones)
      return True;
  }

  for (iVolume = 0; iVolume < ListVolume.Length; iVolume++)
    if (ListVolume[iVolume].Encompasses(Actor))
      return True;

  return False;
}


// ============================================================================
// RateJail
//
// Called by Jailbreak.RatePlayerStart() to determine which playerstart in what
// jail should be used to spawn the player. Jails with a lower priority are
// preferred over those with a higher one.
// ============================================================================

function int RateJail() {
  if (PrisonerLimit > 0 && PrisonerLimit <= CountPlayersTotal()) // full!
    return -30000000;

  return 10000000/(Priority+1);
}


// ============================================================================
// CountPlayers
//
// Counts the number of players of the given team that are in this jail.
// ============================================================================

function int CountPlayers(TeamInfo Team)
{
  local int nPlayersJailed;
  local JBTagPlayer firstTagPlayer;
  local JBTagPlayer thisTagPlayer;

  firstTagPlayer = JBGameReplicationInfo(Level.Game.GameReplicationInfo).firstTagPlayer;
  for (thisTagPlayer = firstTagPlayer; thisTagPlayer != None; thisTagPlayer = thisTagPlayer.nextTag)
    if (thisTagPlayer.GetTeam() == Team &&
        thisTagPlayer.GetJail() == Self)
      nPlayersJailed++;

  return nPlayersJailed;
}


// ============================================================================
// CountPlayersTotal
//
// Counts the total number of players that are in this jail.
// ============================================================================

function int CountPlayersTotal()
{
  local int nPlayersJailed;
  local JBTagPlayer firstTagPlayer;
  local JBTagPlayer thisTagPlayer;

  firstTagPlayer = JBGameReplicationInfo(Level.Game.GameReplicationInfo).firstTagPlayer;
  for (thisTagPlayer = firstTagPlayer; thisTagPlayer != None; thisTagPlayer = thisTagPlayer.nextTag)
    if (thisTagPlayer.GetJail() == Self)
      nPlayersJailed++;

  return nPlayersJailed;
}


// ============================================================================
// Release
//
// Releases the given team unless the release is already active or has been
// jammed. Can be called only in state Waiting and logs a warning otherwise.
// ============================================================================

function Release(TeamInfo Team, optional Controller ControllerInstigator)
{
  local Controller thisController;
  local PlayerReplicationInfo PlayerReplicationInfoInstigator;
  local JBTagPlayer TagPlayer;
  local bool bCanPlayReleaseMessage;

  if (IsInState('Waiting')) {
    if (GetReleaseActive(Team.TeamIndex) ||
        (IsJammed(Team.TeamIndex) &&
        !IsForcedRelease(Team.TeamIndex)))
      return;

    if (ControllerInstigator != None &&
        ControllerInstigator.PlayerReplicationInfo.Team != Team) {
      Log("Warning:" @ ControllerInstigator.PlayerReplicationInfo.PlayerName @ "on team" @
          ControllerInstigator.PlayerReplicationInfo.Team.TeamIndex @ "attempted to release team" @ Team.TeamIndex);
      return;
    }

    if (CanReleaseTeam(Team)) {
      bCanPlayReleaseMessage = Jailbreak(Level.Game).CanPlayReleaseMessage(Team.TeamIndex);
      if (bCanPlayReleaseMessage || Jailbreak(Level.Game).CanFireEvent(GetEventRelease(Team), True)) {
        if (bCanPlayReleaseMessage || Jailbreak(Level.Game).CanFireEvent(Tag, True)) {
          if (ControllerInstigator != None)
            PlayerReplicationInfoInstigator = ControllerInstigator.PlayerReplicationInfo;

          if (CountPlayers(Team) > 0)
            for (thisController = Level.ControllerList; thisController != None; thisController = thisController.NextController)
              if (PlayerController(thisController) != None) {
                TagPlayer = Class'JBTagPlayer'.Static.FindFor(thisController.PlayerReplicationInfo);
                if (TagPlayer           == None ||
                    TagPlayer.GetTeam() != Team ||
                    TagPlayer.GetJail() == none ||
                    TagPlayer.GetJail() == Self) {
                  Jailbreak(Level.Game).PlayingReleaseMessage(Team.TeamIndex);
                  Level.Game.BroadcastHandler.BroadcastLocalized(
                    Self, PlayerController(thisController), MessageClass, 200, PlayerReplicationInfoInstigator, , Team);
                }
              }

          JBBotTeam(TeamGame(Level.Game).Teams[0].AI).NotifyReleaseTeam(Tag, Team, ControllerInstigator);
          JBBotTeam(TeamGame(Level.Game).Teams[1].AI).NotifyReleaseTeam(Tag, Team, ControllerInstigator);
        }

        if (ControllerInstigator != None)
               TriggerEventRelease(GetEventRelease(Team), Self, ControllerInstigator.Pawn);
          else TriggerEventRelease(GetEventRelease(Team), Self, None);
      }

      SetReleaseActive(Team.TeamIndex, True);
      InfoReleaseByTeam[Team.TeamIndex].bIsOpening     = True;
      InfoReleaseByTeam[Team.TeamIndex].TimeActivation = Level.TimeSeconds;
      InfoReleaseByTeam[Team.TeamIndex].TimeReset      = 0.0;  // disabled
      InfoReleaseByTeam[Team.TeamIndex].ControllerInstigator = ControllerInstigator;

      NotifyJailOpening(Team);
    }

    else {
      CancelRelease(Team);
    }
  }

  else {
    Log("Warning: Release for" @ Self @ "should not be called in state" @ GetStateName());
  }
}


// ============================================================================
// TriggerEventRelease
//
// Works like TriggerEvent, but hides the instigator from movers to avoid
// getting team kills when a jail door crushes a teammate.
// ============================================================================

function TriggerEventRelease(name event, Actor ActorSender, Pawn PawnInstigator)
{
  local Actor thisActor;
  local NavigationPoint thisNavigationPoint;

  if (Event == '')
    return;

  foreach DynamicActors(Class'Actor', thisActor, Event)
    if (Mover(thisActor) == None)
           thisActor.Trigger(ActorSender, PawnInstigator);
      else thisActor.Trigger(ActorSender, None);  // hide instigator from mover

  for (thisNavigationPoint = Level.NavigationPointList;
       thisNavigationPoint != None;
       thisNavigationPoint = thisNavigationPoint.NextNavigationPoint)
    if (thisNavigationPoint.bStatic &&
        thisNavigationPoint.Tag == Event)
      thisNavigationPoint.Trigger(ActorSender, PawnInstigator);
}


// ============================================================================
// CancelRelease
//
// Cancels a release that has been initiated. If the release did not start yet,
// doesn't open the jail doors, but marks the release as active and schedules
// a reset shortly; otherwise just resets the internal release state and fires
// the remaining notification events in the correct order as if the jail doors
// had closed.
// ============================================================================

function CancelRelease(TeamInfo Team)
{
  if (GetReleaseActive(Team.TeamIndex)) {
    if (InfoReleaseByTeam[Team.TeamIndex].bIsOpening)
      NotifyJailOpened(Team);

    SetReleaseActive(Team.TeamIndex, False);
    InfoReleaseByTeam[Team.TeamIndex].bIsOpening = False;
    InfoReleaseByTeam[Team.TeamIndex].TimeReset  = 0.0;  // disable

    NotifyJailClosed(Team);
    ResetObjectives(Team);
  }

  else {
    SetReleaseActive(Team.TeamIndex, True);
    InfoReleaseByTeam[Team.TeamIndex].bIsOpening     = False;
    InfoReleaseByTeam[Team.TeamIndex].TimeActivation = Level.TimeSeconds;
    InfoReleaseByTeam[Team.TeamIndex].TimeReset      = Level.TimeSeconds + 2.0;
  }

  InfoReleaseByTeam[Team.TeamIndex].ControllerInstigator = None;
}


// ============================================================================
// NotifyJailOpening
//
// Called when the doors to this jail start opening before NotifyJailOpened is
// called. Disables all GameObjectives that can be used to trigger this jail's
// release and communicates the event to all inmates.
// ============================================================================

function NotifyJailOpening(TeamInfo Team)
{
  local GameObjective firstObjective;
  local GameObjective thisObjective;
  local JBGameRules firstJBGameRules;
  local JBTagPlayer firstTagPlayer;
  local JBTagPlayer thisTagPlayer;

  if (!IsJammed(Team.TeamIndex)) //dont play animation if the jail is jammed.
  {
    firstObjective = UnrealTeamInfo(Team).AI.Objectives;
    for (thisObjective = firstObjective; thisObjective != None; thisObjective = thisObjective.NextObjective)
      if (thisObjective.Event == Tag &&
          thisObjective.DefenderTeamIndex != Team.TeamIndex)
        thisObjective.bDisabled = True;
  }

  firstTagPlayer = JBGameReplicationInfo(Level.Game.GameReplicationInfo).firstTagPlayer;
  for (thisTagPlayer = firstTagPlayer; thisTagPlayer != None; thisTagPlayer = thisTagPlayer.nextTag)
    if (thisTagPlayer.GetJail() == Self &&
        thisTagPlayer.GetTeam() == Team)
      thisTagPlayer.NotifyJailOpening();

  firstJBGameRules = Jailbreak(Level.Game).GetFirstJBGameRules();
  if (firstJBGameRules != None)
    firstJBGameRules.NotifyJailOpening(Self, Team);
}


// ============================================================================
// NotifyJailOpened
//
// Called when the doors to this jail have fully opened. Communicates that
// event to all inmates.
// ============================================================================

function NotifyJailOpened(TeamInfo Team)
{
  local JBGameRules firstJBGameRules;
  local JBTagPlayer firstTagPlayer;
  local JBTagPlayer thisTagPlayer;

  firstTagPlayer = JBGameReplicationInfo(Level.Game.GameReplicationInfo).firstTagPlayer;
  for (thisTagPlayer = firstTagPlayer; thisTagPlayer != None; thisTagPlayer = thisTagPlayer.nextTag)
    if (thisTagPlayer.GetJail() == Self &&
        thisTagPlayer.GetTeam() == Team)
      thisTagPlayer.NotifyJailOpened();

  firstJBGameRules = Jailbreak(Level.Game).GetFirstJBGameRules();
  if (firstJBGameRules != None)
    firstJBGameRules.NotifyJailOpened(Self, Team);
}


// ============================================================================
// NotifyJailEntered
//
// Called when a player enters this jail from an arena or from freedom. If the
// jail doors are currently open, notifies the player about it.
// ============================================================================

function NotifyJailEntered(JBTagPlayer TagPlayer)
{
  local int iTeam;
  local JBGameRules firstJBGameRules;

  iTeam = TagPlayer.GetTeam().TeamIndex;

  if (GetReleaseActive(iTeam) &&
      InfoReleaseByTeam[iTeam].TimeReset == 0.0) {

    TagPlayer.NotifyJailOpening();

    if (!InfoReleaseByTeam[iTeam].bIsOpening)
      TagPlayer.NotifyJailOpened();
  }

  firstJBGameRules = Jailbreak(Level.Game).GetFirstJBGameRules();
  if (firstJBGameRules != None)
    firstJBGameRules.NotifyPlayerJailed(TagPlayer);
}


// ============================================================================
// NotifyJailLeft
//
// Called when a player left this jail for an arena or for freedom.
// ============================================================================

function NotifyJailLeft(JBTagPlayer TagPlayer)
{
  local JBGameRules firstJBGameRules;

  firstJBGameRules = Jailbreak(Level.Game).GetFirstJBGameRules();
  if (firstJBGameRules != None)
    firstJBGameRules.NotifyPlayerReleased(TagPlayer, Self);
}


// ============================================================================
// NotifyJailClosed
//
// Called when this jail is closed. Communicates that event to all inmates.
// ============================================================================

function NotifyJailClosed(TeamInfo Team)
{
  local JBGameRules firstJBGameRules;
  local JBTagPlayer firstTagPlayer;
  local JBTagPlayer thisTagPlayer;

  firstTagPlayer = JBGameReplicationInfo(Level.Game.GameReplicationInfo).firstTagPlayer;
  for (thisTagPlayer = firstTagPlayer; thisTagPlayer != None; thisTagPlayer = thisTagPlayer.nextTag)
    if (thisTagPlayer.GetJail() == Self &&
        thisTagPlayer.GetTeam() == Team)
      thisTagPlayer.NotifyJailClosed();

  firstJBGameRules = Jailbreak(Level.Game).GetFirstJBGameRules();
  if (firstJBGameRules != None)
    firstJBGameRules.NotifyJailClosed(Self, Team);
}


// ============================================================================
// ResetObjectives
//
// Resets all objectives associated with this jail for the given team unless
// the release for another jail listening to the same event is still active.
// ============================================================================

function ResetObjectives(TeamInfo Team)
{
  local GameObjective firstObjective;
  local GameObjective thisObjective;
  local JBInfoJail firstJail;
  local JBInfoJail thisJail;

  firstJail = JBGameReplicationInfo(Level.Game.GameReplicationInfo).firstJail;
  for (thisJail = firstJail; thisJail != None; thisJail = thisJail.nextJail)
    if (thisJail != Self &&
        thisJail.Tag == Tag &&
        thisJail.IsReleaseActive(Team))
      return;

  firstObjective = UnrealTeamInfo(Team).AI.Objectives;
  for (thisObjective = firstObjective; thisObjective != None; thisObjective = thisObjective.NextObjective)
    if (thisObjective.Event == Tag &&
        thisObjective.DefenderTeamIndex != Team.TeamIndex &&
        thisObjective.bDisabled)
      thisObjective.Reset();
}


// ============================================================================
// ActivateCameraFor
//
// Activates the attached camera or camera array for the given player.
// ============================================================================

function ActivateCameraFor(Controller Controller)
{
  local JBCamera thisCamera;

  if (PlayerController(Controller) != None)
    foreach DynamicActors(Class'JBCamera', thisCamera, Event)
      thisCamera.TriggerForController(Self, Controller);
}


// ============================================================================
// ExecutePlayer
//
// Executes the given player. Used for fallback execution.
// ============================================================================

function ExecutePlayer(Controller Controller)
{
  if (Controller.Pawn != None)
    Controller.Pawn.Died(None, Class'Suicided', Controller.Pawn.Location);
}


// ============================================================================
// ExecutionInit
//
// Initiates the execution sequence. Can be called only in state Waiting and
// logs a warning otherwise.
// ============================================================================

function ExecutionInit()
{
  if (IsInState('Waiting'))
    GotoState('ExecutionStarting');
  else
    Log("Warning: Called ExecutionInit for" @ Self @ "in state" @ GetStateName());
}


// ============================================================================
// ExecutionEnd
//
// Finishes up an ongoing execution by gibbing all players remaining in jail
// and going back to state Waiting. Can be called only in states
// ExecutionRunning and ExecutionFallback.
// ============================================================================

function ExecutionEnd()
{
  local JBTagPlayer firstTagPlayer;
  local JBTagPlayer thisTagPlayer;

  if (IsInState('ExecutionRunning') ||
      IsInState('ExecutionFallback')) {

    firstTagPlayer = JBGameReplicationInfo(Level.Game.GameReplicationInfo).firstTagPlayer;
    for (thisTagPlayer = firstTagPlayer; thisTagPlayer != None; thisTagPlayer = thisTagPlayer.nextTag)
      if (thisTagPlayer.GetJail() == Self)
        ExecutePlayer(thisTagPlayer.GetController());

    if (bIsFinalExecution && EventFinalExecutionEnd != '') {
      if (Jailbreak(Level.Game).CanFireEvent(EventFinalExecutionEnd, True))
        TriggerEvent(EventFinalExecutionEnd, Self, None);
    } else {
     if (Jailbreak(Level.Game).CanFireEvent(EventExecutionEnd, True))
        TriggerEvent(EventExecutionEnd, Self, None);
    }

    bIsFinalExecution = False;

    GotoState('Waiting');
  }

  else {
    Log("Warning: Called ExecutionEnd for" @ Self @ "in state" @ GetStateName());
  }
}


// ============================================================================
// GetReleaseActive
//
// Returns whether or not the specified team is currently being released.
// ============================================================================

simulated function bool GetReleaseActive(int TeamIndex)
{
  switch (TeamIndex) {
    case 0: return bIsRedActive;
    case 1: return bIsBlueActive;
    default: return false;
  }
}

// ============================================================================
// SetReleaseActive
// ============================================================================

simulated protected function SetReleaseActive(int TeamIndex, bool Value)
{
  switch (TeamIndex) {
    case 0: bIsRedActive = Value; break;
    case 1: bIsBlueActive = Value; break;
  }
}


// ============================================================================
// Jam
//
// Jams the jail for the given team. A regular release isn't possible any more.
// ============================================================================

function Jam(int TeamIndex)
{
  if (GetReleaseActive(TeamIndex))
    CancelRelease(Jailbreak(Level.Game).Teams[TeamIndex]); // Cancel any ongoing release

  switch (TeamIndex) {
    case 0: bRedJammed = True; break;
    case 1: bBlueJammed = True; break;
  }

  JamResetObjectives(TeamIndex);
}


// ============================================================================
// UnJam
//
// UnJams the jail for the given team. A regular release is possible again.
// ============================================================================

function UnJam(int TeamIndex)
{
  switch (TeamIndex) {
    case 0: bRedJammed = False; break;
    case 1: bBlueJammed = False; break;
  }

  JamResetObjectives(TeamIndex);
}


// ============================================================================
// JamResetObjectives
//
// Resets the GameObjectives that trigger this JBInfoJail.
// ============================================================================

protected function JamResetObjectives(int TeamIndex)
{
  local GameObjective firstObjective;
  local GameObjective thisObjective;

  firstObjective = Jailbreak(Level.Game).Teams[TeamIndex].AI.Objectives;

  // Find all objectives that trigger this JBInfoJail, then reset them
  for (thisObjective = firstObjective; thisObjective != None; thisObjective = thisObjective.NextObjective)
    if (thisObjective.Event == Tag &&
        thisObjective.DefenderTeamIndex != TeamIndex)
      thisObjective.Reset();
}


// ============================================================================
// IsJammed
//
// Returns if this jail is jammed for the given team.
// ============================================================================

simulated function bool IsJammed(int TeamIndex)
{
  switch (TeamIndex) {
    case 0: return bRedJammed;
    case 1: return bBlueJammed;
    default: return False;
  }
}


// ============================================================================
// IsForcedRelease
//
// Returns if the release was forced for the given team.
// ============================================================================

function bool IsForcedRelease(int TeamIndex)
{
  switch (TeamIndex) {
    case 0: return bForcedReleaseRed;
    case 1: return bForcedReleaseBlue;
    default: return False;
  }
}


// ============================================================================
// ForceRelease
//
// Releases even though the jails are jammed. JBGameRules is first consulted
// before actually releasing. Returns if the team was actually released.
// ============================================================================

function bool ForceRelease(TeamInfo Team, optional Controller ControllerInstigator)
{
  local JBGameRules firstJBGameRules;
  local bool        bAllowForcedRelease;

  if (!IsInState('Waiting') ||
       GetReleaseActive(Team.TeamIndex))
    return False;

  if(!IsJammed(Team.TeamIndex)) {
    Release(Team, ControllerInstigator);
    return True;
  }

  firstJBGameRules = Jailbreak(Level.Game).GetFirstJBGameRules();
  if (firstJBGameRules != None)
    bAllowForcedRelease = firstJBGameRules.AllowForcedRelease(Self, Team, ControllerInstigator);

  if (bAllowForcedRelease) {
    switch (Team.TeamIndex) {
      case 0: bForcedReleaseRed  = True; Release(Team, ControllerInstigator); bForcedReleaseRed  = False; break;
      case 1: bForcedReleaseBlue = True; Release(Team, ControllerInstigator); bForcedReleaseBlue = False; break;
    }
  }

  return bAllowForcedRelease;
}


// ============================================================================
// state Waiting
//
// Jail waits for a release to be triggered or an execution to be started.
// ============================================================================

auto state Waiting {

  // ================================================================
  // BeginState
  //
  // Starts the timer.
  // ================================================================

  event BeginState()
  {
    SetTimer(0.2, True);
  }


  // ================================================================
  // Trigger
  //
  // If triggered from a GameObjective, releases players from the
  // team that can attack that objective even if the release was
  // triggered by a defender. Otherwise releases the triggering
  // player's team.
  // ================================================================

  event Trigger(Actor ActorOther, Pawn PawnInstigator)
  {
    local Controller ControllerInstigator;
    local GameObjective firstObjective;
    local GameObjective thisObjective;
    local GameObjective ObjectiveRelease;
    local TeamInfo TeamRelease;
    local JBGameRules firstJBGameRules;

    ObjectiveRelease = GameObjective(ActorOther);

    if (ObjectiveRelease != None)
      TeamRelease = TeamGame(Level.Game).OtherTeam(TeamGame(Level.Game).Teams[ObjectiveRelease.DefenderTeamIndex]);
    else if (PawnInstigator != None)
      TeamRelease = PawnInstigator.GetTeam();

    if (TeamRelease != None) {
      if (Trigger(ActorOther) != None) {
        firstObjective = UnrealTeamInfo(TeamRelease).AI.Objectives;
        for (thisObjective = firstObjective; thisObjective != None; thisObjective = thisObjective.NextObjective)
          if (thisObjective.DefenderTeamIndex != TeamRelease.TeamIndex &&
              JBGameObjective(thisObjective) != None &&
              JBGameObjective(thisObjective).TriggerRelease == ActorOther)
            ObjectiveRelease = thisObjective;
      }

      if (PawnInstigator != None)
        ControllerInstigator = PawnInstigator.Controller;

      firstJBGameRules = Jailbreak(Level.Game).GetFirstJBGameRules();
      if (Level.Game.IsInState('MatchInProgress') &&
          CanReleaseBy(ControllerInstigator, TeamRelease) &&
          (firstJBGameRules == None ||
           firstJBGameRules.CanRelease(TeamRelease, PawnInstigator, ObjectiveRelease))) {
        Release(TeamRelease, ControllerInstigator);
        return;
      }
    }

    CancelRelease(TeamRelease);
  }


  // ================================================================
  // Timer
  //
  // For each team whose release is active, checks whether the jail
  // doors have been closed already and, if so, resets that team's
  // release information.
  // ================================================================

  event Timer()
  {
    local int iTeam;
    local TeamInfo Team;

    if (TeamGame(Level.Game) == None)
      return;

    for (iTeam = 0; iTeam < ArrayCount(InfoReleaseByTeam); iTeam++) {
      Team = TeamGame(Level.Game).Teams[iTeam];

      if (!GetReleaseActive(iTeam))
        continue;

      if (InfoReleaseByTeam[iTeam].bIsOpening) {
        if (IsReleaseMoverOpen(Team)) {
          InfoReleaseByTeam[iTeam].bIsOpening = False;
          NotifyJailOpened(Team);
        }
      }

      else if (IsReleaseMoverClosed(Team)) {
        if (InfoReleaseByTeam[iTeam].TimeReset == 0.0) {
          InfoReleaseByTeam[iTeam].TimeReset = Level.TimeSeconds + 0.5;
          NotifyJailClosed(Team);
        }

        else if (InfoReleaseByTeam[iTeam].TimeReset < Level.TimeSeconds) {
          SetReleaseActive(Team.TeamIndex, False);
          InfoReleaseByTeam[iTeam].bIsOpening = False;
          InfoReleaseByTeam[iTeam].TimeActivation = 0.0;
          InfoReleaseByTeam[iTeam].TimeReset      = 0.0;
          InfoReleaseByTeam[iTeam].ControllerInstigator = None;
          ResetObjectives(Team);
        }
      }
    }
  }


  // ================================================================
  // EndState
  //
  // Cancels all ongoing releases and stops the timer.
  // ================================================================

  event EndState()
  {
    local int iTeam;

    for (iTeam = 0; iTeam < ArrayCount(InfoReleaseByTeam); iTeam++)
      if (GetReleaseActive(iTeam))
        CancelRelease(TeamGame(Level.Game).Teams[iTeam]);

    SetTimer(0.0, False);
  }

} // state Waiting


// ============================================================================
// state ExecutionStarting
//
// Execution has been initiated, but has not started yet. Automatically goes
// to state ExecutionRunning after the specified delay.
// ============================================================================

state ExecutionStarting {

  Begin:
    if (Level.Game.bOverTime ||
        Level.Game.GameReplicationInfo.GoalScore > 0 &&
         (Level.Game.GameReplicationInfo.GoalScore == int(Level.Game.GameReplicationInfo.Teams[0].Score) ||
          Level.Game.GameReplicationInfo.GoalScore == int(Level.Game.GameReplicationInfo.Teams[1].Score))) {
      bIsFinalExecution = True;
    }

    if (bIsFinalExecution && EventFinalExecutionInit != '') {
      if (Jailbreak(Level.Game).CanFireEvent(EventFinalExecutionInit, True))
        TriggerEvent(EventFinalExecutionInit, Self, None);

      Sleep(FinalExecutionDelayCommit);
    } else {
     if (Jailbreak(Level.Game).CanFireEvent(EventExecutionInit, True))
        TriggerEvent(EventExecutionInit, Self, None);

      Sleep(ExecutionDelayCommit);
    }

    GotoState('ExecutionRunning');

} // state ExecutionStarting


// ============================================================================
// state ExecutionRunning
//
// Remains in this state until either fallback gibbing kicks in or explicitely
// reset by calling ExecutionEnd. The Jailbreak game class takes care of that.
// ============================================================================

state ExecutionRunning {

  Begin:
    if (bIsFinalExecution && EventFinalExecutionCommit != '') {
      if (Jailbreak(Level.Game).CanFireEvent(EventFinalExecutionCommit, True))
        TriggerEvent(EventFinalExecutionCommit, Self, None);

      Sleep(FinalExecutionDelayFallback);
    } else {
     if (Jailbreak(Level.Game).CanFireEvent(EventExecutionCommit, True))
        TriggerEvent(EventExecutionCommit, Self, None);

      Sleep(ExecutionDelayFallback);
    }

    GotoState('ExecutionFallback');

} // state ExecutionRunning


// ============================================================================
// state ExecutionFallback
//
// Performs fallback execution sequence by killing all players in jail.
// ============================================================================

state ExecutionFallback {

  // ================================================================
  // BeginState
  //
  // Starts the timer.
  // ================================================================

  event BeginState()
  {
    SetTimer(1.0, True);
  }


  // ================================================================
  // Timer
  //
  // Periodically checks for players remaining in jail and gibs any
  // it finds.
  // ================================================================

  event Timer()
  {
    local JBTagPlayer firstTagPlayer;
    local JBTagPlayer thisTagPlayer;

    firstTagPlayer = JBGameReplicationInfo(Level.Game.GameReplicationInfo).firstTagPlayer;
    for (thisTagPlayer = firstTagPlayer; thisTagPlayer != None; thisTagPlayer = thisTagPlayer.nextTag)
      if (thisTagPlayer.IsInJail())
        ExecutePlayer(thisTagPlayer.GetController());
  }


  // ================================================================
  // EndState
  //
  // Stops the timer.
  // ================================================================

  event EndState()
  {
    SetTimer(0.0, False);
  }

} // state ExecutionFallback


// ============================================================================
// Accessors
// ============================================================================

simulated function bool IsReleaseActive(TeamInfo Team) {
  return GetReleaseActive(Team.TeamIndex); }

function bool IsReleaseOpening(TeamInfo Team) {
  return GetReleaseActive(Team.TeamIndex) &&
         InfoReleaseByTeam[Team.TeamIndex].bIsOpening; }
function bool IsReleaseOpen(TeamInfo Team) {
  return GetReleaseActive(Team.TeamIndex) &&
        !InfoReleaseByTeam[Team.TeamIndex].bIsOpening &&
         InfoReleaseByTeam[Team.TeamIndex].TimeReset == 0.0; }

function Controller GetReleaseInstigator(TeamInfo Team) {
  return InfoReleaseByTeam[Team.TeamIndex].ControllerInstigator; }
function float GetReleaseTime(TeamInfo Team) {
  return InfoReleaseByTeam[Team.TeamIndex].TimeActivation; }


// ============================================================================
// Defaults
// ============================================================================

defaultproperties
{
  MessageClass = Class'JBLocalMessage';

  ExecutionDelayCommit   = 1.0;
  ExecutionDelayFallback = 2.0;

  FinalExecutionDelayCommit   = 1.0;
  FinalExecutionDelayFallback = 2.0;

  TagAttachZones   = Auto;
  TagAttachVolumes = None;

  Texture = Texture'JBInfoJail';
  bAlwaysRelevant = True;
  RemoteRole = ROLE_SimulatedProxy;
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Class file time: Di 20.11.2012 13:14:54.000 - Creation time: Do 14.8.2014 09:58:42.512 - Created with UnCodeX