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

Engine.Controller


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
//=============================================================================
// Controller, the base class of players or AI.
//
// Controllers are non-physical actors that can be attached to a pawn to control
// its actions.  PlayerControllers are used by human players to control pawns, while
// AIControFllers implement the artificial intelligence for the pawns they control.
// Controllers take control of a pawn using their Possess() method, and relinquish
// control of the pawn by calling UnPossess().
//
// Controllers receive notifications for many of the events occuring for the Pawn they
// are controlling.  This gives the controller the opportunity to implement the behavior
// in response to this event, intercepting the event and superceding the Pawn's default
// behavior.
//
// This is a built-in Unreal class and it shouldn't be modified.
//=============================================================================
class Controller extends Actor
    config(user)
    native
    nativereplication
    abstract;

var Pawn Pawn;

var const int       PlayerNum;          // The player number - per-match player number.
var     float       SightCounter;       // Used to keep track of when to check player visibility
var     float       FovAngle;           // X field of view angle in degrees, usually 90.
var globalconfig float  Handedness;
var     bool        bIsPlayer;          // Pawn is a player or a player-bot.
var     bool        bGodMode;           // cheat - when true, can't be killed or hurt

//AI flags
var const bool      bLOSflag;           // used for alternating LineOfSight traces
var     bool        bAdvancedTactics;   // serpentine movement between pathnodes
var     bool        bCanOpenDoors;
var     bool        bCanDoSpecial;
var     bool        bAdjusting;         // adjusting around obstacle
var     bool        bPreparingMove;     // set true while pawn sets up for a latent move
var     bool        bControlAnimations; // take control of animations from pawn (don't let pawn play animations based on notifications)
var     bool        bEnemyInfoValid;    // false when change enemy, true when LastSeenPos etc updated
var     bool        bNotifyApex;        // event NotifyJumpApex() when at apex of jump
var     bool        bUsePlayerHearing;
var     bool        bJumpOverWall;      // true when jumping to clear obstacle
var     bool        bEnemyAcquired;
var     bool        bSoaking;           // pause and focus on this bot if it encounters a problem
var     bool        bHuntPlayer;        // hunting player
var     bool        bAllowedToTranslocate;
var     bool        bAllowedToImpactJump;
var     bool        bAdrenalineEnabled;
var     bool        bNotifyFallingHitWall;
var     bool        bSlowerZAcquire;    // acquire targets above or below more slowly than at same height
var     bool        bInDodgeMove;
var     bool        bVehicleTransition;
var     bool        bForceStrafe;
var     bool        bNotifyPostLanded;

// Input buttons.
var input byte
    bRun, bDuck, bFire, bAltFire, bVoiceTalk;

var     vector      AdjustLoc;          // location to move to while adjusting around obstacle

var const   Controller      nextController; // chained Controller list

var     float       Stimulus;           // Strength of stimulus - Set when stimulus happens

// Navigation AI
var     float       MoveTimer;
var     Actor       MoveTarget;     // actor being moved toward
var     vector      Destination;    // location being moved toward
var     vector      FocalPoint;     // location being looked at
var     Actor       Focus;          // actor being looked at
var     float       FocusLead;      // how much to lead view of focus
var     Mover       PendingMover;   // mover pawn is waiting for to complete its move
var     Actor       GoalList[4];    // used by navigation AI - list of intermediate goals
var NavigationPoint home;           // set when begin play, used for retreating and attitude checks
var     float       MinHitWall;     // Minimum HitNormal dot Velocity.Normal to get a HitWall event from the physics
var     float       RespawnPredictionTime;  // how far ahead to predict respawns when looking for inventory
var     float       DodgeToGoalPct; // Frequency bot tries to dodge to reachable goal
var     int         AcquisitionYawRate;
var     float       DodgeLandZ;     // expected min landing height of dodge
var     Vehicle     LastBlockingVehicle;

// Enemy information
var     Pawn        Enemy;
var     Actor       Target;
var     vector      LastSeenPos;    // enemy position when I last saw enemy (auto updated if EnemyNotVisible() enabled)
var     vector      LastSeeingPos;  // position where I last saw enemy (auto updated if EnemyNotVisible enabled)
var     float       LastSeenTime;

var string VoiceType; // OBSOLETE
var float OldMessageTime; //to limit frequency of voice messages

// Route Cache for Navigation
var Actor       RouteCache[16];
var ReachSpec   CurrentPath;
var ReachSpec   NextRoutePath;
var vector      CurrentPathDir;
var Actor       RouteGoal; //final destination for current route
var float       RouteDist;  // total distance for current route
var float       LastRouteFind;  // time at which last route finding occured
var     vector      DirectionHint;      // used to pick which side of vehicle to get out on

// Replication Info
var() class<PlayerReplicationInfo> PlayerReplicationInfoClass;
var PlayerReplicationInfo PlayerReplicationInfo;

var class<Pawn> PawnClass;  // class of pawn to spawn (for players)
var class<Pawn> PreviousPawnClass;  // Holds the player's previous class

var float GroundPitchTime;
var vector ViewX, ViewY, ViewZ; // Viewrotation encoding for PHYS_Spider

var NavigationPoint StartSpot;  // where player started the match

// for monitoring the position of a pawn
var     vector      MonitorStartLoc;    // used by latent function MonitorPawn()
var     Pawn        MonitoredPawn;      // used by latent function MonitorPawn()
var     float       MonitorMaxDistSq;

var     AvoidMarker FearSpots[2];   // avoid these spots when moving

var float WarningDelay;     // delay before act on firing warning
var Projectile WarningProjectile;
var Pawn ShotTarget;
var const Actor LastFailedReach;    // cache to avoid trying failed actorreachable more than once per frame
var const float FailedReachTime;
var const vector FailedReachLocation;

var float Adrenaline;
var float           AdrenalineMax;       // maximum Adrenaline (combo energy)
var class<Weapon> LastPawnWeapon;               // used by game stats

const LATENT_MOVETOWARD = 503; // LatentAction number for Movetoward() latent function

replication
{
    reliable if( bNetDirty && (Role==ROLE_Authority) )
        PlayerReplicationInfo, Pawn;
    reliable if( bNetDirty && (Role== ROLE_Authority) && bNetOwner )
        PawnClass, Adrenaline,bAdrenalineEnabled;

    // Functions the server calls on the client side.
    reliable if( RemoteRole==ROLE_AutonomousProxy )
        ClientGameEnded, ClientRoundEnded, ClientDying, ClientSetRotation, ClientSetLocation,
        ClientSwitchToBestWeapon, ClientSetWeapon;
    reliable if ( (!bDemoRecording || (bClientDemoRecording && bClientDemoNetFunc)) && Role == ROLE_Authority )
        ClientVoiceMessage;

    // Functions the client calls on the server.
    unreliable if( Role<ROLE_Authority )
        SendVoiceMessage, SetPawnClass;
    reliable if ( Role < ROLE_Authority )
        ServerRestartPlayer;
}

// Latent Movement.
//Note that MoveTo sets the actor's Destination, and MoveToward sets the
//actor's MoveTarget.  Actor will rotate towards destination unless the optional ViewFocus is specified.

native(500) final latent function MoveTo( vector NewDestination, optional Actor ViewFocus, optional bool bShouldWalk);
native(502) final latent function MoveToward(actor NewTarget, optional Actor ViewFocus, optional float DestinationOffset, optional bool bUseStrafing, optional bool bShouldWalk);
native(508) final latent function FinishRotation();

// native AI functions
/* LineOfSightTo() returns true if any of several points of Other is visible
  (origin, top, bottom)
*/
native(514) final function bool LineOfSightTo(actor Other);

/* CanSee() similar to line of sight, but also takes into account Pawn's peripheral vision
*/
native(533) final function bool CanSee(Pawn Other);

//Navigation functions - return the next path toward the goal
native(518) final function Actor FindPathTo(vector aPoint);
native(517) final function Actor FindPathToward(actor anActor, optional bool bWeightDetours);
native final function Actor FindPathToIntercept(Pawn P, Actor RouteGoal, optional bool bWeightDetours);
native final function Actor FindPathTowardNearest(class<NavigationPoint> GoalClass, optional bool bWeightDetours);
native(525) final function NavigationPoint FindRandomDest();

native(523) final function vector EAdjustJump(float BaseZ, float XYSpeed);

//Reachable returns whether direct path from Actor to aPoint is traversable
//using the current locomotion method
native(521) final function bool pointReachable(vector aPoint);
native(520) final function bool actorReachable(actor anActor);

/* PickWallAdjust()
Check if could jump up over obstruction (only if there is a knee height obstruction)
If so, start jump, and return current destination
Else, try to step around - return a destination 90 degrees right or left depending on traces
out and floor checks
*/
native(526) final function bool PickWallAdjust(vector HitNormal);

/* WaitForLanding()
latent function returns when pawn is on ground (no longer falling)
*/
native(527) final latent function WaitForLanding();

native(540) final function actor FindBestInventoryPath(out float MinWeight);
native final function actor FindBestSuperPickup(float MaxDist); // find nearest super pickup (base has bDelayedSpawn=true)

native(529) final function AddController();
native(530) final function RemoveController();

// Pick best pawn target
native(531) final function pawn PickTarget(out float bestAim, out float bestDist, vector FireDir, vector projStart, float MaxRange);
native(534) final function actor PickAnyTarget(out float bestAim, out float bestDist, vector FireDir, vector projStart);

native final function bool InLatentExecution(int LatentActionNumber); //returns true if controller currently performing latent action specified by LatentActionNumber
// Force end to sleep
native function StopWaiting();
native function EndClimbLadder();

native final function bool CanMakePathTo(Actor A); // assumes valid CurrentPath, tries to see if CurrentPath can be combine with path to N

event MayFall(); //return true if allowed to fall - called by engine when pawn is about to fall

event MayDodgeToMoveTarget();

event MissedDodge();

function PendingStasis()
{
    bStasis = true;
    Pawn = None;
}

// ----- combos ----- //

function AwardAdrenaline(float Amount)
{
    if ( bAdrenalineEnabled )
    {
        Adrenaline += Amount;
        Adrenaline = Clamp( Adrenaline, 0, AdrenalineMax );
    }
}

function bool NeedsAdrenaline()
{
    return ( (Pawn != None) && !Pawn.InCurrentCombo() && (Adrenaline < AdrenalineMax) );
}

/* DisplayDebug()
list important controller attributes on canvas
*/
function DisplayDebug(Canvas Canvas, out float YL, out float YPos)
{
    local string DebugString;

    if ( Pawn == None )
    {
        Super.DisplayDebug(Canvas,YL,YPos);
        return;
    }

    Canvas.SetDrawColor(255,0,0);
    Canvas.DrawText("CONTROLLER "$GetItemName(string(self))$" Pawn "$GetItemName(string(Pawn))$" viewpitch "$Rotation.Pitch);
    YPos += YL;
    Canvas.SetPos(4,YPos);

    if ( Enemy != None )
        Canvas.DrawText("     STATE: "$GetStateName()$" Timer: "$TimerCounter$" Enemy "$Enemy.GetHumanReadableName(), false);
    else
        Canvas.DrawText("     STATE: "$GetStateName()$" Timer: "$TimerCounter$" NO Enemy ", false);
    YPos += YL;
    Canvas.SetPos(4,YPos);


    if ( MonitoredPawn != None )
        DebugString $= "     MonitoredPawn: "@MonitoredPawn.GetHumanReadableName();
    else
        DebugString $= "     MonitoredPawn: None";
    if ( Target != None )
        DebugString $= "     Target: "@Target.GetHumanReadableName();
    else
        DebugString $= "     Target: None";
    Canvas.DrawText(DebugString);
    YPos += YL;
    Canvas.SetPos(4,YPos);

    if ( PlayerReplicationInfo == None )
        Canvas.DrawText("     NO PLAYERREPLICATIONINFO", false);
    else
        PlayerReplicationInfo.DisplayDebug(Canvas,YL,YPos);

    YPos += YL;
    Canvas.SetPos(4,YPos);
}

simulated function String GetHumanReadableName()
{
    if ( PlayerReplicationInfo != None )
        return PlayerReplicationInfo.PlayerName;
    return GetItemName(String(self));
}

simulated function rotator GetViewRotation()
{
    return Rotation;
}

/* Reset()
reset actor to initial state
*/
function Reset()
{
    super.Reset();

    Enemy = None;
    LastSeenTime = 0;
    StartSpot = None;
    Adrenaline = 0;
    bAdjusting = false;
    bPreparingMove = false;
    bJumpOverWall = false;
    bEnemyAcquired = false;
    bHuntPlayer = false;
    bInDodgeMove = false;
    MoveTimer = -1;
    MoveTarget = None;
    PendingMover = None;
    CurrentPath = None;
    RouteGoal = None;
    MonitoredPawn = None;
    WarningProjectile = None;
}

function bool AvoidCertainDeath()
{
    return false;
}

/* ClientSetLocation()
replicated function to set location and rotation.  Allows server to force new location for
teleports, etc.
*/
function ClientSetLocation( vector NewLocation, rotator NewRotation )
{
    SetRotation(NewRotation);
    If ( (Rotation.Pitch > RotationRate.Pitch)
        && (Rotation.Pitch < 65536 - RotationRate.Pitch) )
    {
        If (Rotation.Pitch < 32768)
            NewRotation.Pitch = RotationRate.Pitch;
        else
            NewRotation.Pitch = 65536 - RotationRate.Pitch;
    }
    if ( Pawn != None )
    {
        NewRotation.Roll  = 0;
        Pawn.SetRotation( NewRotation );
        Pawn.SetLocation( NewLocation );
    }
}

/* ClientSetRotation()
replicated function to set rotation.  Allows server to force new rotation.
*/
function ClientSetRotation( rotator NewRotation )
{
    SetRotation(NewRotation);
    if ( Pawn != None )
    {
        NewRotation.Pitch = 0;
        NewRotation.Roll  = 0;
        Pawn.SetRotation( NewRotation );
    }
}

function ClientDying(class<DamageType> DamageType, vector HitLocation)
{
    if ( Pawn != None )
    {
        Pawn.PlayDying(DamageType, HitLocation);
        Pawn.GotoState('Dying');
    }
}

/* AIHearSound()
Called when AI controlled pawn would hear a sound.  Default AI implementation uses MakeNoise()
interface for hearing appropriate sounds instead
*/
event AIHearSound (
    actor Actor,
    int Id,
    sound S,
    vector SoundLocation,
    vector Parameters,
    bool Attenuate
);

event SoakStop(string problem);

function Possess(Pawn aPawn)
{
    aPawn.PossessedBy(self);
    Pawn = aPawn;
    if ( PlayerReplicationInfo != None )
    {
        if ( Vehicle(Pawn) != None && Vehicle(Pawn).Driver != None )
            PlayerReplicationInfo.bIsFemale = Vehicle(Pawn).Driver.bIsFemale;
        else
            PlayerReplicationInfo.bIsFemale = Pawn.bIsFemale;
    }

    // preserve Pawn's rotation initially for placed Pawns
    FocalPoint = Pawn.Location + 512*vector(Pawn.Rotation);
    Restart();
}

// unpossessed a pawn (not because pawn was killed)
function UnPossess()
{
    if ( Pawn != None )
        Pawn.UnPossessed();
    Pawn = None;
}

function WasKilledBy(Controller Other);

function class<Weapon> GetLastWeapon()
{
    if ( (Pawn == None) || (Pawn.Weapon == None) )
        return LastPawnWeapon;
    return Pawn.Weapon.Class;
}

/* PawnDied()
 unpossess a pawn (because pawn was killed)
 */
function PawnDied(Pawn P)
{
    if ( Pawn != P )
        return;
    if ( Pawn != None )
    {
        if ( Pawn.InCurrentCombo() )
            Adrenaline = 0;
        SetLocation(Pawn.Location);
        Pawn.UnPossessed();
    }
    Pawn = None;
    PendingMover = None;
    if ( bIsPlayer )
    {
        if ( !IsInState('GameEnded') && !IsInState('RoundEnded') )
            GotoState('Dead'); // can respawn
    }
    else
        Destroy();
}

function Restart()
{
    Enemy = None;
}

event LongFall(); // called when latent function WaitForLanding() doesn't return after 4 seconds

// notifications of pawn events (from C++)
// if return true, then pawn won't get notified
event bool NotifyPhysicsVolumeChange(PhysicsVolume NewVolume);
event bool NotifyHeadVolumeChange(PhysicsVolume NewVolume);
event bool NotifyLanded(vector HitNormal);
event NotifyPostLanded();
event bool NotifyHitWall(vector HitNormal, actor Wall);
event NotifyFallingHitWall(vector HitNormal, actor Wall); // only if bNotifyFallingHitWall is set
event bool NotifyBump(Actor Other);
event NotifyHitMover(vector HitNormal, mover Wall);
event NotifyJumpApex();
event NotifyMissedJump();

function SetDoubleJump();

// notifications called by pawn in script
function NotifyAddInventory(inventory NewItem);
function NotifyTakeHit(pawn InstigatedBy, vector HitLocation, int Damage, class<DamageType> damageType, vector Momentum)
{
    if ( (instigatedBy != None) && (instigatedBy != pawn) )
        damageAttitudeTo(instigatedBy, Damage);
}

function SetFall(); //about to fall
function PawnIsInPain(PhysicsVolume PainVolume);    // called when pawn is taking pain volume damage

event PreBeginPlay()
{
    AddController();
    Super.PreBeginPlay();
    if ( bDeleteMe )
        return;

    SightCounter = 0.2 * FRand();  //offset randomly
}

event PostBeginPlay()
{
    Super.PostBeginPlay();
    if ( !bDeleteMe && bIsPlayer && (Level.NetMode != NM_Client) )
    {
        PlayerReplicationInfo = Spawn(PlayerReplicationInfoClass, Self,,vect(0,0,0),rot(0,0,0));
        InitPlayerReplicationInfo();
    }
}

function InitPlayerReplicationInfo()
{
    if (PlayerReplicationInfo.PlayerName == "")
        PlayerReplicationInfo.SetPlayerName(class'GameInfo'.Default.DefaultPlayerName);

    PlayerReplicationInfo.bNoTeam = !Level.Game.bTeamGame;
}

simulated function int GetTeamNum()
{
    if ( (PlayerReplicationInfo == None) || (PlayerReplicationInfo.Team == None) )
        return 255;

    return PlayerReplicationInfo.Team.TeamIndex;
}

function bool SameTeamAs(Controller C)
{
    if ( C == None )
        return false;
    return Level.Game.IsOnTeam(C,GetTeamNum());
}

function HandlePickup(Pickup pick)
{
    if ( MoveTarget == pick )
    {
        if ( pick.MyMarker != None )
        {
            MoveTarget = pick.MyMarker;
            Pawn.Anchor = pick.MyMarker;
            MoveTimer = 0.5;
        }
        else
            MoveTimer = -1.0;
    }
}

simulated event Destroyed()
{
    if ( Role < ROLE_Authority )
    {
        Super.Destroyed();
        return;
    }

    RemoveController();

    if ( bIsPlayer && (Level.Game != None) )
        Level.Game.logout(self);
    if ( PlayerReplicationInfo != None )
    {
        if ( !PlayerReplicationInfo.bOnlySpectator && (PlayerReplicationInfo.Team != None) )
            PlayerReplicationInfo.Team.RemoveFromTeam(self);
        PlayerReplicationInfo.Destroy();
    }
    Super.Destroyed();
}

event bool AllowDetourTo(NavigationPoint N)
{
    return true;
}

/* AdjustView()
by default, check and see if pawn still needs to update eye height
(only if some playercontroller still has pawn as its viewtarget)
Overridden in playercontroller
*/
function AdjustView( float DeltaTime )
{
    local Controller C;

    for ( C=Level.ControllerList; C!=None; C=C.NextController )
        if ( C.IsA('PlayerController') && (PlayerController(C).ViewTarget == Pawn) )
            return;

    Pawn.bUpdateEyeHeight =false;
    Pawn.Eyeheight = Pawn.BaseEyeheight;
}

function bool WantsSmoothedView()
{
    return ( (Pawn != None) && ((Pawn.Physics==PHYS_Walking) || (Pawn.Physics==PHYS_Spider)) && !Pawn.bJustLanded );
}

function GameHasEnded()
{
    if ( Pawn != None )
        Pawn.bNoWeaponFiring = true;
    GotoState('GameEnded');
}

function ClientGameEnded()
{
    GotoState('GameEnded');
}

function RoundHasEnded()
{
    if ( Pawn != None )
        Pawn.bNoWeaponFiring = true;
    GotoState('RoundEnded');
}

function ClientRoundEnded()
{
    GotoState('RoundEnded');
}

simulated event RenderOverlays( canvas Canvas );

/* GetFacingDirection()
returns direction faced relative to movement dir

0 = forward
16384 = right
32768 = back
49152 = left
*/
function int GetFacingDirection()
{
    return 0;
}

//------------------------------------------------------------------------------
// Speech related

function byte GetMessageIndex(name PhraseName)
{
    return 0;
}

function SendMessage(PlayerReplicationInfo Recipient, name MessageType, byte MessageID, float Wait, name BroadcastType)
{
    SendVoiceMessage(PlayerReplicationInfo, Recipient, MessageType, MessageID, BroadcastType);
}

function bool AllowVoiceMessage(name MessageType)
{
    if ( Level.TimeSeconds - OldMessageTime < 10 )
        return false;
    else
        OldMessageTime = Level.TimeSeconds;

    return true;
}

function SendVoiceMessage(PlayerReplicationInfo Sender, PlayerReplicationInfo Recipient, name messagetype, byte messageID, name broadcasttype)
{
    local Controller P;

    if ( ((Recipient == None) || (AIController(self) == None))
        && !AllowVoiceMessage(MessageType) )
        return;

    for ( P=Level.ControllerList; P!=None; P=P.NextController )
    {
        if ( PlayerController(P) != None )
        {
            if ((P.PlayerReplicationInfo == Sender) ||
                (P.PlayerReplicationInfo == Recipient &&
                 (Level.Game.BroadcastHandler == None ||
                  Level.Game.BroadcastHandler.AcceptBroadcastSpeech(PlayerController(P), Sender)))
                )
                P.ClientVoiceMessage(Sender, Recipient, messagetype, messageID);
            else if ( (Recipient == None) || (Level.NetMode == NM_Standalone) )
            {
                if ( (broadcasttype == 'GLOBAL') || !Level.Game.bTeamGame || (Sender.Team == P.PlayerReplicationInfo.Team) )
                    if ( Level.Game.BroadcastHandler == None || Level.Game.BroadcastHandler.AcceptBroadcastSpeech(PlayerController(P), Sender) )
                        P.ClientVoiceMessage(Sender, Recipient, messagetype, messageID);
            }
        }
        else if ( (messagetype == 'ORDER') && ((Recipient == None) || (Recipient == P.PlayerReplicationInfo)) )
            P.BotVoiceMessage(messagetype, messageID, self);
    }
}

function ClientVoiceMessage(PlayerReplicationInfo Sender, PlayerReplicationInfo Recipient, name messagetype, byte messageID);
function BotVoiceMessage(name messagetype, byte MessageID, Controller Sender);

//***************************************************************
// interface used by ScriptedControllers to query pending controllers

function bool WouldReactToNoise( float Loudness, Actor NoiseMaker)
{
    return false;
}

function bool WouldReactToSeeing(Pawn Seen)
{
    return false;
}

//***************************************************************
// AI related

/* AdjustToss()
return adjustment to Z component of aiming vector to compensate for arc given the target
distance
*/
function vector AdjustToss(float TSpeed, vector Start, vector End, bool bNormalize)
{
    local vector Dest2D, Result, Vel2D;
    local float Dist2D;

    if ( Start.Z > End.Z + 64 )
    {
        Dest2D = End;
        Dest2D.Z = Start.Z;
        Dist2D = VSize(Dest2D - Start);
        TSpeed *= Dist2D/VSize(End - Start);
        Result = SuggestFallVelocity(Dest2D,Start,TSpeed,TSpeed);
        Vel2D = result;
        Vel2D.Z = 0;
        Result.Z = Result.Z + (End.Z - Start.Z) * VSize(Vel2D)/Dist2D;
    }
    else
    {
        Result = SuggestFallVelocity(End,Start,TSpeed,TSpeed);
    }
    if ( bNormalize )
        return TSpeed * Normal(Result);
    else
        return Result;
}

event PrepareForMove(NavigationPoint Goal, ReachSpec Path);
function WaitForMover(Mover M);
function MoverFinished();
function UnderLift(Mover M);

function FearThisSpot(AvoidMarker aSpot)
{
    local int i;

    if ( Pawn == None )
        return;
    if ( !LineOfSightTo(aSpot) )
        return;
    for ( i=0; i<2; i++ )
        if ( FearSpots[i] == None )
        {
            FearSpots[i] = aSpot;
            return;
        }
    for ( i=0; i<2; i++ )
        if ( VSize(Pawn.Location - FearSpots[i].Location) > VSize(Pawn.Location - aSpot.Location) )
        {
            FearSpots[i] = aSpot;
            return;
        }
}

event float Desireability(Pickup P)
{
    return P.BotDesireability(Pawn);
}

event float SuperDesireability(Pickup P)
{
    return P.BotDesireability(Pawn);
}

/* called before start of navigation network traversal to allow setup of transient navigation flags
*/
event SetupSpecialPathAbilities();

event HearNoise( float Loudness, Actor NoiseMaker);
event SeePlayer( Pawn Seen );   // called when a player (bIsPlayer==true) pawn is seen
event SeeMonster( Pawn Seen );  // called when a non-player (bIsPlayer==false) pawn is seen
event EnemyNotVisible();

function DamageShake(int damage);
function ShakeView(vector shRotMag,    vector shRotRate,    float shRotTime,
                   vector shOffsetMag, vector shOffsetRate, float shOffsetTime);

function NotifyKilled(Controller Killer, Controller Killed, pawn Other)
{
    if ( Enemy == Other )
        Enemy = None;
}

function damageAttitudeTo(pawn Other, float Damage);
function float AdjustDesireFor(Pickup P);
function bool FireWeaponAt(Actor A);

function StopFiring()
{
    if ( Pawn != None )
        Pawn.StopWeaponFiring();
    bFire = 0;
    bAltFire = 0;
}

simulated function float RateWeapon(Weapon w)
{
    return w.Default.Priority;
}

function float WeaponPreference(Weapon W)
{
    return 0.0;
}

/* AdjustAim()
AIController version does adjustment for non-controlled pawns.
PlayerController version does the adjustment for player aiming help.
Only adjusts aiming at pawns
allows more error in Z direction (full as defined by AutoAim - only half that difference for XY)
*/
function rotator AdjustAim(FireProperties FiredAmmunition, vector projStart, int aimerror)
{
    return Rotation;
}

function InstantWarnTarget(Actor Target, FireProperties FiredAmmunition, vector FireDir)
{
    local float Dist;

    if ( FiredAmmunition.bInstantHit && (Pawn(Target) != None) && (Pawn(Target).Controller != None)  )
    {
        Dist = VSize(Pawn.Location - Target.Location);
        if ( VSize(FireDir * Dist - Target.Location) < Target.CollisionRadius )
            return;
        if ( FRand() < FiredAmmunition.WarnTargetPct )
            Pawn(Target).Controller.ReceiveWarning(Pawn, -1, FireDir);
        return;
    }
}
/* ReceiveWarning()
 AI controlled creatures may duck
 if not falling, and projectile time is long enough
 often pick opposite to current direction (relative to shooter axis)
*/
event ReceiveWarning(Pawn shooter, float projSpeed, vector FireDir);

function ReceiveProjectileWarning(Projectile proj)
{
    if ( WarningProjectile == None )
        ReceiveWarning(Proj.Instigator, Proj.speed, Normal(Proj.Velocity));
}

/* If ReceiveWarning caused WarningDelay to be set, this will be called when it times out
*/
event DelayedWarning();

exec function SwitchToBestWeapon()
{
    local float rating;

    if ( Pawn == None || Pawn.Inventory == None )
        return;

    if ( (Pawn.PendingWeapon == None) || (AIController(self) != None) )
    {
        Pawn.PendingWeapon = Pawn.Inventory.RecommendWeapon(rating);
        if ( Pawn.PendingWeapon == Pawn.Weapon )
            Pawn.PendingWeapon = None;
        if ( Pawn.PendingWeapon == None )
            return;
    }

    StopFiring();

    if ( Pawn.Weapon == None )
        Pawn.ChangedWeapon();
    else if ( Pawn.Weapon != Pawn.PendingWeapon )
    {
        Pawn.Weapon.PutDown();
    }
}

// server calls this to force client to switch
function ClientSwitchToBestWeapon()
{
    SwitchToBestWeapon();
}

function ClientSetWeapon( class<Weapon> WeaponClass )
{
    local Inventory Inv;
    local int Count;

    for( Inv = Pawn.Inventory; Inv != None; Inv = Inv.Inventory )
    {
        Count++;
        if ( Count > 1000 )
            return;
        if( !ClassIsChildOf( Inv.Class, WeaponClass ) )
            continue;

        if( Pawn.Weapon == None )
        {
            Pawn.PendingWeapon = Weapon(Inv);
            Pawn.ChangedWeapon();
        }
        else if ( Pawn.Weapon != Weapon(Inv) )
        {
            Pawn.PendingWeapon = Weapon(Inv);
            Pawn.Weapon.PutDown();
        }

        return;
    }
}

function SetPawnClass(string inClass, string inCharacter)
{
    local class<Pawn> pClass;

    if ( inClass == "" )
        return;
    pClass = class<Pawn>(DynamicLoadObject(inClass, class'Class'));
    if ( pClass != None )
        PawnClass = pClass;
}

function SetPawnFemale();

function bool CheckFutureSight(float DeltaTime)
{
    return true;
}

function ChangedWeapon()
{
    if ( Pawn.Weapon != None )
        LastPawnWeapon = Pawn.Weapon.Class;
}

function ServerReStartPlayer()
{
    if ( Level.NetMode == NM_Client )
        return;
    if ( Pawn != None )
        ServerGivePawn();
}

function ServerGivePawn();

event MonitoredPawnAlert();

function StartMonitoring(Pawn P, float MaxDist)
{
    MonitoredPawn = P;
    MonitorStartLoc = P.Location;
    MonitorMaxDistSq = MaxDist * MaxDist;
}

function bool AutoTaunt()
{
    return false;
}

function bool DontReuseTaunt(int T)
{
    return false;
}

// - ParseChatPercVar should be subclassed if a controller needs more of them
function string ParseChatPercVar(string Cmd)
{
    if (cmd~="%A")  // Adrenaline
        return int(Adrenaline)@"Adrenaline";

    if ( (Pawn != None) && (cmd~="%S") ) // Shield
        return int(Pawn.ShieldStrength)@"Shield";

    return Cmd;
}

// **********************************************
// Controller States

State Dead
{
ignores SeePlayer, HearNoise, KilledBy;

    function PawnDied(Pawn P)
    {
        if ( Level.NetMode != NM_Client )
            warn(self$" Pawndied while dead");
    }

    function ServerReStartPlayer()
    {
        if ( Level.NetMode == NM_Client )
            return;
        Level.Game.RestartPlayer(self);
    }
}

state GameEnded
{
ignores SeePlayer, HearNoise, KilledBy, NotifyBump, HitWall, NotifyPhysicsVolumeChange, NotifyHeadVolumeChange, Falling, TakeDamage, ReceiveWarning;

    function BeginState()
    {
        if ( Pawn != None )
        {
            if ( Pawn.Weapon != None )
                Pawn.Weapon.HolderDied();
            Pawn.SimAnim.AnimRate = 0;
            Pawn.TurnOff();
            Pawn.UnPossessed();
            Pawn = None;
        }
        if ( !bIsPlayer )
            Destroy();
    }
}

state RoundEnded
{
ignores SeePlayer, HearNoise, KilledBy, NotifyBump, HitWall, NotifyPhysicsVolumeChange, NotifyHeadVolumeChange, Falling, TakeDamage, ReceiveWarning;

    function BeginState()
    {
        if ( Pawn != None )
        {
            if ( Pawn.Weapon != None )
                Pawn.Weapon.HolderDied();
            Pawn.SimAnim.AnimRate = 0;
            Pawn.TurnOff();
            Pawn.UnPossessed();
            Pawn = None;
        }
        if ( !bIsPlayer )
            Destroy();
    }
}

defaultproperties
{
     FovAngle=90.000000
     bAdrenalineEnabled=True
     bSlowerZAcquire=True
     MinHitWall=-1.000000
     AcquisitionYawRate=20000
     PlayerReplicationInfoClass=Class'Engine.PlayerReplicationInfo'
     AdrenalineMax=100.000000
     bHidden=True
     bOnlyRelevantToOwner=True
     RemoteRole=ROLE_None
     RotationRate=(Pitch=3072,Yaw=30000,Roll=2048)
     bHiddenEd=True
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Class file time: Mon 23/10/2006 20:25:18.000 - Creation time: Wed 7/2/2007 19:16:35.953 - Created with UnCodeX