Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |
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 01251 01252 01253 01254 01255 01256 01257 01258 01259 01260 01261 01262 01263 01264 01265 01266 01267 01268 01269 01270 01271 01272 01273 01274 01275 01276 01277 01278 01279 01280 01281 01282 01283 01284 01285 01286 01287 01288 01289 01290 01291 01292 01293 01294 01295 01296 01297 01298 01299 01300 01301 01302 01303 01304 01305 01306 01307 01308 01309 01310 01311 01312 01313 01314 01315 01316 01317 01318 01319 01320 01321 01322 01323 01324 01325 01326 01327 01328 01329 01330 01331 01332 01333 01334 01335 01336 01337 01338 01339 01340 01341 01342 01343 01344 01345 01346 01347 01348 01349 01350 01351 01352 01353 01354 01355 01356 01357 01358 01359 01360 01361 01362 01363 01364 01365 01366 01367 01368 01369 01370 01371 01372 01373 01374 01375 01376 01377 01378 01379 01380 01381 01382 01383 01384 01385 01386 01387 01388 01389 01390 01391 01392 01393 01394 01395 01396 01397 01398 01399 01400 01401 01402 01403 01404 01405 01406 01407 01408 01409 01410 01411 01412 01413 01414 01415 01416 01417 01418 01419 01420 01421 01422 01423 01424 01425 01426 01427 01428 01429 01430 01431 01432 01433 01434 01435 01436 01437 01438 01439 01440 01441 01442 01443 01444 01445 01446 01447 01448 01449 01450 01451 01452 01453 01454 01455 01456 01457 01458 01459 01460 01461 01462 01463 01464 01465 01466 01467 01468 01469 01470 01471 01472 01473 01474 01475 01476 01477 01478 01479 01480 01481 01482 01483 01484 01485 01486 01487 01488 01489 01490 01491 01492 01493 01494 01495 01496 01497 01498 01499 01500 01501 01502 01503 01504 01505 01506 01507 01508 01509 01510 01511 01512 01513 01514 01515 01516 01517 01518 01519 01520 01521 01522 01523 01524 01525 01526 01527 01528 01529 01530 01531 01532 01533 01534 01535 01536 01537 01538 01539 01540 01541 01542 01543 01544 01545 01546 01547 01548 01549 01550 01551 01552 01553 01554 01555 01556 01557 01558 01559 01560 01561 01562 01563 01564 01565 01566 01567 01568 01569 01570 01571 01572 01573 01574 01575 01576 01577 01578 01579 01580 01581 01582 01583 01584 01585 01586 01587 01588 01589 01590 01591 01592 01593 01594 01595 01596 01597 01598 01599 01600 01601 01602 01603 01604 01605 01606 01607 01608 01609 01610 01611 01612 01613 01614 01615 01616 01617 01618 01619 01620 01621 01622 01623 01624 01625 01626 01627 01628 01629 01630 01631 01632 01633 01634 01635 01636 01637 01638 01639 01640 01641 01642 01643 01644 01645 01646 01647 01648 01649 01650 01651 01652 01653 01654 01655 01656 01657 01658 01659 01660 01661 01662 01663 01664 01665 01666 01667 01668 01669 01670 01671 01672 01673 01674 01675 01676 01677 01678 01679 01680 01681 01682 01683 01684 01685 01686 01687 01688 01689 01690 01691 01692 01693 01694 01695 01696 01697 01698 01699 01700 01701 01702 01703 01704 01705 01706 01707 01708 01709 01710 01711 01712 01713 01714 01715 01716 01717 01718 01719 01720 01721 01722 01723 01724 01725 01726 01727 01728 01729 01730 01731 01732 01733 01734 01735 01736 01737 01738 01739 01740 01741 01742 01743 01744 01745 01746 01747 01748 01749 01750 01751 01752 01753 01754 01755 01756 01757 01758 01759 01760 01761 01762 01763 01764 01765 01766 01767 01768 01769 01770 01771 01772 01773 01774 01775 01776 01777 01778 01779 01780 01781 01782 01783 01784 01785 01786 01787 01788 01789 01790 01791 01792 01793 01794 01795 01796 01797 01798 01799 01800 01801 01802 01803 01804 01805 01806 01807 01808 01809 01810 01811 01812 01813 01814 01815 01816 01817 01818 01819 01820 01821 01822 01823 01824 01825 01826 01827 01828 01829 01830 01831 01832 01833 01834 01835 01836 01837 01838 01839 01840 01841 01842 01843 01844 01845 01846 01847 01848 01849 01850 01851 01852 01853 01854 01855 01856 01857 01858 01859 01860 01861 01862 01863 01864 01865 01866 01867 01868 01869 01870 01871 01872 01873 01874 01875 01876 01877 01878 01879 01880 01881 01882 01883 01884 01885 01886 01887 01888 01889 01890 01891 01892 01893 01894 01895 01896 01897 01898 01899 01900 01901 01902 01903 01904 01905 01906 01907 01908 01909 01910 01911 01912 01913 01914 01915 01916 01917 01918 01919 01920 01921 01922 01923 01924 01925 01926 01927 01928 01929 01930 01931 01932 01933 01934 01935 01936 01937 01938 01939 01940 01941 01942 01943 01944 01945 01946 01947 01948 01949 01950 01951 01952 01953 01954 01955 01956 01957 01958 01959 01960 01961 01962 01963 01964 01965 01966 01967 01968 01969 01970 01971 01972 01973 01974 01975 01976 01977 01978 01979 01980 01981 01982 01983 01984 01985 01986 01987 01988 01989 01990 01991 01992 01993 01994 01995 01996 01997 01998 01999 02000 02001 02002 02003 02004 02005 02006 02007 02008 02009 02010 02011 02012 02013 02014 02015 02016 02017 02018 02019 02020 02021 02022 02023 02024 02025 02026 02027 02028 02029 02030 02031 02032 02033 02034 02035 02036 02037 02038 02039 02040 02041 02042 02043 02044 02045 02046 02047 02048 02049 02050 02051 02052 02053 02054 02055 02056 02057 02058 02059 02060 02061 02062 02063 02064 02065 02066 02067 02068 02069 02070 02071 02072 02073 02074 02075 02076 02077 02078 02079 02080 02081 02082 02083 02084 02085 02086 02087 02088 02089 02090 02091 02092 02093 02094 02095 02096 02097 02098 02099 02100 02101 02102 02103 02104 02105 02106 02107 02108 02109 02110 02111 02112 02113 02114 02115 |
/** * Base Weapon implementation. * Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. */ class Weapon extends Inventory native abstract config(game); /** Logging pre-processor macros */ #linenumber 12 /************************************************************************************ * Firing Mode Definition ***********************************************************************************/ /** * This enum defines the firing type for the weapon. * EWFT_InstantHit - The weapon traces a shot to determine a hit and immediately causes an effect * EWFT_Projectile - The weapon spawns a new projectile pointed at the crosshair * EWFT_Custom - Requires a custom fire sequence */ enum EWeaponFireType { EWFT_InstantHit, EWFT_Projectile, EWFT_Custom, EWFT_None }; /** Current FireMode*/ var byte CurrentFireMode; /** Array of firing states defining available firemodes */ var Array<Name> FiringStatesArray; /** Defines the type of fire (see Enum above) for each mode */ var Array<EWeaponFireType> WeaponFireTypes; /** The Class of Projectile to spawn */ var Array< class<Projectile> > WeaponProjectiles; /** Holds the amount of time a single shot takes */ var() Array<float> FireInterval; /** How much of a spread between shots */ var() Array<float> Spread; /** How much damage does a given instanthit shot do */ var() Array<float> InstantHitDamage; /** momentum transfer scaling for instant hit damage */ var() Array<float> InstantHitMomentum; /** DamageTypes for Instant Hit Weapons */ var Array< class<DamageType> > InstantHitDamageTypes; /************************************************************************************ * Firing / Timing / States ***********************************************************************************/ /** How long does it take to Equip this weapon */ var() float EquipTime; /** How long does it take to put this weapon down */ var() float PutDownTime; /** Holds an offest for spawning protectile effects. */ var() vector FireOffset; /** Set to put weapon down at the end of a state. Typically used to change weapons on state changes (weapon up, stopped firing...) */ var bool bWeaponPutDown; /** Range of Weapon, used for Traces (InstantFire, ProjectileFire, AdjustAim...) */ var() float WeaponRange; /********************************************************************************************* * Mesh / Skins / Effects ********************************************************************************************* */ /** Weapon Mesh */ var() editinline MeshComponent Mesh; /** When no duration is specified, speed to play anims. */ var() float DefaultAnimSpeed; /********************************************************************************************* * Inventory Grouping/etc. ********************************************************************************************* */ /** Configurable weapon priority. Ties (mod weapons) are broken by GroupWeight */ var databinding config float Priority; /** Can player toss his weapon out? Typically false for default inventory. */ var bool bCanThrow; /********************************************************************************************* * AI Hints ********************************************************************************************* */ var array<byte> ShouldFireOnRelease; var bool bInstantHit; var bool bMeleeWeapon; var float AIRating; /** Cache MaxRange of weapon */ var float CachedMaxRange; /********************************************************************************************* * Initialization / System Messages / Utility *********************************************************************************************/ /** Event called when weapon actor is destroyed */ simulated event Destroyed() { // detach weapon from instigator DetachWeapon(); super.Destroyed(); } /** * A notification call when this weapon is removed from the Inventory of a pawn * @see Inventory::ItemRemovedFromInvManager */ function ItemRemovedFromInvManager() { // detach weapon from instigator DetachWeapon(); if( IsActiveWeapon() ) { Instigator.Weapon = None; } super.ItemRemovedFromInvManager(); } /** * Informs if this weapon is active for the player * * @return true if this an active weapon for the player */ simulated function bool IsActiveWeapon() { if( InvManager != None ) { return InvManager.IsActiveWeapon( Self ); } return false; } /** * Pawn holding this weapon as active weapon just died. */ function HolderDied() { ServerStopFire( CurrentFireMode ); } /** * hook to override Next weapon call. * For example the physics gun uses it to have mouse wheel change the distance of the held object. * Warning: only use in firing state, otherwise it breaks weapon switching */ simulated function bool DoOverrideNextWeapon() { return false; } /** * hook to override Previous weapon call. */ simulated function bool DoOverridePrevWeapon() { return false; } /** * Drop this weapon out in to the world * * @param StartLocation - The World Location to drop this item from * @param StartVelocity - The initial velocity for the item when dropped */ function DropFrom(vector StartLocation, vector StartVelocity) { if( !CanThrow() ) { return; } // Stop Firing ForceEndFire(); // Detach weapon components from instigator DetachWeapon(); // Tell the client the weapon has been thrown ClientWeaponThrown(); // tell the super to DropFrom() which will // should remove the item from our inventory super.DropFrom(StartLocation, StartVelocity); // Become inactive GotoState('Inactive'); } /** * Returns true if this item can be thrown out. */ simulated function bool CanThrow() { return bCanThrow; } /** * This function is called when the client needs to discard the weapon */ reliable client function ClientWeaponThrown() { LogInternal(WorldInfo.TimeSeconds @ Instigator @ GetStateName() $ "::" $ GetFuncName() @ Self,'Inventory'); // Stop Firing ForceEndFire(); // Detach weapon components from instigator DetachWeapon(); // Force it to turn off // Become inactive GotoState('Inactive'); } /** * Returns true if the weapon is firing, used by AI */ simulated event bool IsFiring() { return FALSE; } /** * Returns true if this weapon wants to deny a ClientWeaponSwitch call */ simulated function bool DenyClientWeaponSet() { return FALSE; } /********************************************************************************************* * Debug / Log *********************************************************************************************/ /** * list important Weapon variables on canvas. HUD will call DisplayDebug() on the current ViewTarget when * the ShowDebug exec is used * * @param HUD - HUD with canvas to draw on * @input out_YL - Height of the current font * @input out_YPos - Y position on Canvas. out_YPos += out_YL, gives position to draw text for next debug line. */ simulated function DisplayDebug(HUD HUD, out float out_YL, out float out_YPos) { local Array<String> DebugInfo; local int i; GetWeaponDebug( DebugInfo ); Hud.Canvas.SetDrawColor(0,255,0); for (i=0;i<DebugInfo.Length;i++) { Hud.Canvas.DrawText( " " @ DebugInfo[i] ); out_YPos += out_YL; Hud.Canvas.SetPos(4, out_YPos); } } /** * Retrieves important weapon debug information as an array of strings. That can then be dumped or displayed on HUD. */ simulated function GetWeaponDebug( out Array<String> DebugInfo ) { local String T; local int i; DebugInfo[DebugInfo.Length] = "Weapon:" $ GetItemName(string(Self)) @ "State:" $ GetStateName() @ "Instigator:" $ Instigator @ "Owner:" $ Owner; DebugInfo[DebugInfo.Length] = "IsFiring():" $ IsFiring() @ "CurrentFireMode:" $ CurrentFireMode @ "bWeaponPutDown:" $ bWeaponPutDown; if (Instigator != None) { DebugInfo[DebugInfo.Length] = "ShotCount:" $ Instigator.ShotCount @ "FlashCount:" $ Instigator.FlashCount @ "FlashLocation:" $ Instigator.FlashLocation; } T = "PendingFires:"; for(i=0; i<InvManager.PendingFire.Length; i++) { T = T $ PendingFire(i) $ " "; } DebugInfo[DebugInfo.Length] = T; if( Timers.Length > 0 ) { for (i=0;i<Timers.Length;i++) { DebugInfo[DebugInfo.Length] = "Timer" @ Timers[i].FuncName @ Timers[i].Count @ Timers[i].Rate @ int(Timers[i].Count/Timers[i].Rate*100)$"%"; } } } /** * Dump debug information for this weapon to log file. */ simulated function DumpWeaponDebugToLog() { local Array<String> DebugInfo; local int i; WeaponLog( "Weapon:" @ Self, GetFuncName() ); GetWeaponDebug( DebugInfo ); for (i=0;i<DebugInfo.Length;i++) { LogInternal("Weapondebuginfo "$ DebugInfo[i]); } } /** * Prints out weapon debug information to log file * * @param Msg String to display * @param FuncStr String telling where the log came from (format: Class::Function) */ simulated function WeaponLog( coerce String Msg, coerce String FuncStr ) { LogInternal("[" $ WorldInfo.TimeSeconds $"]" @ Msg @ "(" $ FuncStr $ ")"); } /********************************************************************************************* * Ammunition / Inventory *********************************************************************************************/ /** * Consumes ammunition when firing a shot. * Subclass me to define weapon ammunition consumption. */ function ConsumeAmmo( byte FireModeNum ); /** * Add ammo to weapon * @param Amount to add. * @return Amount actually added. (In case magazine is already full and some ammo is left * * Subclass me to define ammo addition rules. */ function int AddAmmo(int Amount); /** * This function checks to see if the weapon has any ammo available for a given fire mode. * * @param FireModeNum - The Fire Mode to Test For * @param Amount - [Optional] Check to see if this amount is available. * @return true if ammo is available for Firemode FireModeNum. */ simulated function bool HasAmmo( byte FireModeNum, optional int Amount ) { return true; } /** * returns true if this weapon has any ammo left, regardless of the actual firing mode. */ simulated function bool HasAnyAmmo() { return true; } /********************************************************************************************* * Pending Fire / Inv Manager *********************************************************************************************/ simulated function bool PendingFire(int FireMode) { if (InvManager != none) { return bool( InvManager.PendingFire[FireMode] ); } return false; } simulated function SetPendingFire(int FireMode) { if (InvManager != none) { InvManager.PendingFire[FireMode] = 1; } } simulated function ClearPendingFire(int FireMode) { if (InvManager != none) { InvManager.PendingFire[FireMode] = 0; } } /** * Returns the type of projectile to spawn. We use a function so subclasses can * override it if needed (case in point, homing rockets). */ function class<Projectile> GetProjectileClass() { return (CurrentFireMode < WeaponProjectiles.length) ? WeaponProjectiles[CurrentFireMode] : None; } /** * Adds any fire spread offset to the passed in rotator * @param Aim the base aim direction * @return the adjusted aim direction */ simulated function rotator AddSpread(rotator BaseAim) { local vector X, Y, Z; local float CurrentSpread, RandY, RandZ; CurrentSpread = Spread[CurrentFireMode]; if (CurrentSpread == 0) { return BaseAim; } else { // Add in any spread. GetAxes(BaseAim, X, Y, Z); RandY = FRand() - 0.5; RandZ = Sqrt(0.5 - Square(RandY)) * (FRand() - 0.5); return rotator(X + RandY * CurrentSpread * Y + RandZ * CurrentSpread * Z); } } /** * Returns the Maximum Range for this weapon */ simulated function float MaxRange() { local int i; if ( CachedMaxRange > 0 ) { return CachedMaxRange; } // return the range of the fire mode that fires farthest if (bInstantHit) { CachedMaxRange = WeaponRange; } for (i = 0; i < WeaponProjectiles.length; i++) { if (WeaponProjectiles[i] != None) { CachedMaxRange = FMax(CachedMaxRange, WeaponProjectiles[i].static.GetRange()); } } return CachedMaxRange; } /** * Returns the DamageRadius of projectiles being shot */ function float GetDamageRadius() { local class<Projectile> CurrentProjectileClass; CurrentProjectileClass = GetProjectileClass(); if( CurrentProjectileClass == None ) { return 0; } return CurrentProjectileClass.default.DamageRadius; } /** * This Weapon has just been given to this Pawn * * @param thisPawn new weapon owner */ function GivenTo(Pawn ThisPawn, optional bool bDoNotActivate) { Super.GivenTo(ThisPawn, bDoNotActivate); if( !bDoNotActivate && ThisPawn != None /*&& ThisPawn.Controller != None*/ ) { // Evaluate if we should switch to this weapon ClientWeaponSet(TRUE); } } /********************************************************************************************* * AI interface *********************************************************************************************/ function float GetAIRating() { return AIRating; } function float RelativeStrengthVersus(Pawn P, float Dist) { return 0; } /** * Returns a weight reflecting the desire to use the * given weapon, used for AI and player best weapon * selection. * * @return weapon rating (range -1.f to 1.f) */ simulated function float GetWeaponRating() { if( InvManager != None ) { return InvManager.GetWeaponRatingFor( Self ); } if( !HasAnyAmmo() ) { return -1; } return 1; } function bool RecommendRangedAttack() { return false; } function bool FocusOnLeader(bool bLeaderFiring) { return false; } function bool RecommendLongRangedAttack() { return false; } function float RangedAttackTime() { return 0; } // CanAttack() - return false if out of range, can't see target, etc. function bool CanAttack(Actor Other) { return true; } // tells bot whether to charge or back off while using this weapon function float SuggestAttackStyle() { return 0.0; } // tells bot whether to charge or back off while defending against this weapon function float SuggestDefenseStyle() { return 0.0; } // tells AI that it needs to release the fire button for this weapon to do anything function bool FireOnRelease() { return (ShouldFireOnRelease.Length>0 && ShouldFireOnRelease[CurrentFireMode]!=0); } /********************************************************************************************* * Effects / Mesh / Animations / Sounds *********************************************************************************************/ /** Returns the AnimNodeSequence the weapon is using to play animations. */ simulated function AnimNodeSequence GetWeaponAnimNodeSeq() { local AnimTree Tree; local AnimNodeSequence AnimSeq; local SkeletalMeshComponent SkelMesh; SkelMesh = SkeletalMeshComponent(Mesh); if(SkelMesh != None) { //Try getting an animtree first Tree = AnimTree(SkelMesh.Animations); if (Tree != None) { AnimSeq = AnimNodeSequence(Tree.Children[0].Anim); } else { //Old legacy way without an animtree AnimSeq = AnimNodeSequence(SkelMesh.Animations); } return AnimSeq; } return None; } /** * This function handles playing sounds for weapons. How it plays the sound depends on the following: * * If we are a listen server, then this sound is played and replicated as normal * If we are a remote client, but locally controlled (ie: we are on the client) we play the sound and don't replicate it * If we are a dedicated server, play the sound and replicate it to everyone BUT the owner (he will play it locally). * * * @param SoundCue - The Source Cue to play */ simulated function WeaponPlaySound( SoundCue Sound, optional float NoiseLoudness ) { // if we are a listen server, just play the sound. It will play locally // and be replicated to all other clients. if( Sound == None || Instigator == None ) { return; } Instigator.PlaySound(Sound, false, true); } /** * Play an animation on the weapon mesh * Network: Local Player and clients * * @param Anim Sequence to play on weapon skeletal mesh * @param desired duration, in seconds, animation should be played */ simulated function PlayWeaponAnimation( Name Sequence, float fDesiredDuration, optional bool bLoop, optional SkeletalMeshComponent SkelMesh) { local AnimNodeSequence WeapNode; local AnimTree Tree; // do not play on a dedicated server if( WorldInfo.NetMode == NM_DedicatedServer ) { return; } if ( SkelMesh == None ) { SkelMesh = SkeletalMeshComponent(Mesh); } // Check we have access to mesh and animations if( SkelMesh == None || GetWeaponAnimNodeSeq() == None ) { return; } if(fDesiredDuration > 0.0) { // @todo - this should call GetWeaponAnimNodeSeq, move 'duration' code into AnimNodeSequence and use that. SkelMesh.PlayAnim(Sequence, fDesiredDuration, bLoop); } else { //Try getting an animtree first Tree = AnimTree(SkelMesh.Animations); if (Tree != None) { WeapNode = AnimNodeSequence(Tree.Children[0].Anim); } else { WeapNode = AnimNodeSequence(SkelMesh.Animations); } WeapNode.SetAnim(Sequence); WeapNode.PlayAnim(bLoop, DefaultAnimSpeed); } } /** * Stops an animation on the weapon mesh * Network: Local Player and clients * */ simulated function StopWeaponAnimation() { local AnimNodeSequence AnimSeq; // do not play on a dedicated server if( WorldInfo.NetMode == NM_DedicatedServer ) { return; } AnimSeq = GetWeaponAnimNodeSeq(); if( AnimSeq != None ) { AnimSeq.StopAnim(); } } /** * PlayFireEffects * Main function to play Weapon fire effects. * This is called from Pawn::WeaponFired in the base implementation. */ simulated function PlayFireEffects( byte FireModeNum, optional vector HitLocation ); /** * StopFireEffects * Main function to stop any active effects * This is called from Pawn::WeaponStoppedFiring */ simulated function StopFireEffects(byte FireModeNum); /** * PlayFiringSound - Called after a shot is fired. */ simulated function PlayFiringSound(); /********************************************************************************************* * Timing *********************************************************************************************/ /** * Returns interval in seconds between each shot, for the firing state of FireModeNum firing mode. * * @param FireModeNum fire mode * @return Period in seconds of firing mode */ simulated function float GetFireInterval( byte FireModeNum ) { return FireInterval[FireModeNum] > 0 ? FireInterval[FireModeNum] : 0.01; } /** * Sets the timing for the firing state on server and local client. * By default, a constant looping Rate Of Fire (ROF) is set up. * When the delay has expired, the RefireCheckTimer event is triggered. * * Network: LocalPlayer and Server * * @param FireModeNum Fire Mode. */ simulated function TimeWeaponFiring( byte FireModeNum ) { // if weapon is not firing, then start timer. Firing state is responsible to stopping the timer. if( !IsTimerActive('RefireCheckTimer') ) { SetTimer( GetFireInterval(FireModeNum), true, 'RefireCheckTimer' ); } } simulated function RefireCheckTimer(); /** * Sets the timing for putting a weapon down. The WeaponIsDown event is trigged when expired */ simulated function TimeWeaponPutDown() { SetTimer( PutDownTime>0 ? PutDownTime : 0.01, false, 'WeaponIsDown' ); } /** * Sets the timing for equipping a weapon. * The WeaponEquipped event is trigged when expired */ simulated function TimeWeaponEquipping() { SetTimer( EquipTime>0 ? EquipTime : 0.01 , false, 'WeaponEquipped'); } /** * All inventory use the Activate() function when an item is selected for use. * For weapons, this function starts the Equipping process. If the weapon is the inactive state, * it will go to the 'WeaponEquipping' followed by 'Active' state, and ready to be fired. */ simulated function Activate() { // don't reactivate if already firing if (!IsFiring()) { GotoState('WeaponEquipping'); } } /** * This function is called to put a weapon down */ simulated function PutDownWeapon() { GotoState('WeaponPuttingDown'); } /** * When you pickup an weapon, the inventory system has a chance to restrict the pickup. */ function bool DenyPickupQuery(class<Inventory> ItemClass, Actor Pickup) { // By default, you can only carry a single item of a given class. if( ItemClass == class ) { return true; } return false; } /** * Called when the weapon runs out of ammo during firing */ simulated function WeaponEmpty(); /********************************************************************************************* * Firtst/Third person weapon attachment functions *********************************************************************************************/ /** * Increment Pawn's FlashCount variable. * This is used to play weapon fire effects on remote clients. * Call this on the server and local player. * * Network: Server and Local Player */ simulated function IncrementFlashCount() { if( Instigator != None ) { Instigator.IncrementFlashCount( Self, CurrentFireMode ); } } /** * Clear flashCount variable on Pawn. and call WeaponStoppedFiring event. * Call this on the server and local player. * * Network: Server or Local Player */ simulated function ClearFlashCount() { if( Instigator != None ) { Instigator.ClearFlashCount( Self ); } } /** * This function sets up the Location of a hit to be replicated to all remote clients. * * Network: Server only */ function SetFlashLocation( vector HitLocation ) { if( Instigator != None ) { Instigator.SetFlashLocation( Self, CurrentFireMode, HitLocation ); } } /** * Reset flash location variable. and call stop firing. * Network: Server only */ function ClearFlashLocation() { if( Instigator != None ) { Instigator.ClearFlashLocation( Self ); } } /** * AttachWeaponTo is called when it's time to attach the weapon's mesh to a location. * it should be subclassed. */ simulated function AttachWeaponTo( SkeletalMeshComponent MeshCpnt, optional Name SocketName ); /** * Detach weapon components from instigator. Perform any clean up. * Should be subclassed. */ simulated function DetachWeapon(); /********************************************************************************************* * Pawn/Controller/View functions *********************************************************************************************/ /** Returns the base view aim of the weapon owner */ simulated function GetViewAxes( out vector XAxis, out vector YAxis, out vector ZAxis ) { local Rotator AimRot; // get base weapon aiming AimRot = Instigator.GetBaseAimRotation(); GetAxes( AimRot, XAxis, YAxis, ZAxis ); } /** * This function can be used by a weapon to override a playercontroller's FOVAngle. It should * be overriden in a subclass. */ simulated function float AdjustFOVAngle(float FOVAngle) { return FOVAngle; // Don't do anything by default } /** * is called by the server to tell the client about potential weapon changes after the player runs over * a weapon (the client decides whether to actually switch weapons or not. * Network: LocalPlayer * * @param bOptionalSet. Set to true if the switch is optional. (simple weapon pickup and weight against current weapon). */ reliable client function ClientWeaponSet(bool bOptionalSet) { // If weapon's instigator isn't replicated to client, wait for it in PendingClientWeaponSet state if( Instigator == None ) { //WeaponLog("Instigator == None, going to PendingClientWeaponSet", "Weapon::ClientWeaponSet"); GotoState('PendingClientWeaponSet'); return; } // If weapon's instigator isn't replicated to client, wait for it in PendingClientWeaponSet state if( InvManager == None ) { //WeaponLog("InvManager == None, going to PendingClientWeaponSet", "Weapon::ClientWeaponSet"); GotoState('PendingClientWeaponSet'); return; } InvManager.ClientWeaponSet(Self, bOptionalSet); } /** * WeaponCalcCamera allows a weapon to adjust the pawn's controller's camera. Should be subclassed */ simulated function WeaponCalcCamera(float fDeltaTime, out vector out_CamLoc, out rotator out_CamRot); /********************************************************************************************* * Handling the actual Fire Commands *********************************************************************************************/ /* Weapon Firing Logic overiew: The weapon system here is designed to be a single code path that follows the same flow on both the Authoritive server and the local client. Remote clients know nothing about the weapon and utilize the WeaponAttachment system to see the end results. 1: The InventoryManager (IM) on the Local Client recieves a StartFire call. It calls StartFire(). 2: If Local Client is not Authoritive it notifies the server via ServerStartFire(). 3: Both StartFire() and ServerStartFire() sync up by calling BeginFire(). 4: BeginFire sets the PendingFire flag for the incoming fire Mode 5: BeginFire looks at the current state and if it's in the Active state, it begins the firing sequence by transitioning to the new fire state as defined by the FiringStatesArray array. This is done by called SendToFiringState. 6: The Firing Logic is handled in the various firing states. Firing states are responsible for the following: a: Continuing to fire if their associated PendingFire is hot b: Transitioning to a new weapon when out of ammo c: Transitioning to the "Active" state when no longer firing The weapon system also receives a StopFire() event from the IM. When this occurs, the following logic is performed: 1: The IM on the Local Client calls StopFire(). 2: If Weapon Stop fire is not on the Authoritive process, it notifes the server via the ServerStopFire() event. 3: Both StopFire() and ServerStopFire() sync up by calling EndFire(). 4: EndFire() clears the PendingFire flag for this outgoing fire mode. Firing states should be identical in their execution, branching outwards as need. For example, in the default firing state ('WeaponFiring') the function FireAmmunition() occurs in all applicable processes. */ /** * Called on the LocalPlayer, Fire sends the shoot request to the server (ServerStartFire) * and them simulates the firing effects locally. * Call path: PlayerController::StartFire -> Pawn::StartFire -> InventoryManager::StartFire * Network: LocalPlayer */ simulated function StartFire(byte FireModeNum) { if (Instigator == None || !Instigator.bNoWeaponFiring) { if( Role < Role_Authority ) { // if we're a client, synchronize server ServerStartFire(FireModeNum); } // Start fire locally BeginFire(FireModeNum); DemoBeginFire(FireModeNum); } } /** * When StartFire() is called on a client, it replicates the start by calling ServerStartFire. This * begins the event on server. Server side actors (such as bots) should not call ServerStartFire directly and should * instead call StartFire(). * * Network: Dedicated Server only, or Listen Server for remote clients. */ reliable server function ServerStartFire(byte FireModeNum) { if (Instigator == None || !Instigator.bNoWeaponFiring) { // A client has fired, so the server needs to // begin to fire as well BeginFire(FireModeNum); DemoBeginFire(FireModeNum); } } /** * BeginFire is the point at which the server and client sync up their code path. It's job is to set * the weapon in to the firing state. * Network: LocalPlayer and Server */ simulated function BeginFire(Byte FireModeNum) { // Flag this mode as pending a fire. The only thing that can remove // this flag is a Stop Fire/Putdown command. SetPendingFire(FireModeNum); } /** * This initiates the shutdown of a weapon that is firing. * Network: Local Player */ simulated function StopFire(byte FireModeNum) { // Locally shut down the fire sequence EndFire(FireModeNum); DemoEndFire(FireModeNum); // Notify the server if( Role < Role_Authority ) { ServerStopFire(FireModeNum); } } /** * When StopFire is called on a client, ServerStopFire is used to initiate the sequence on the server. * Network: Dedicated Server only, or Listen Server for remote clients. */ reliable server function ServerStopFire(byte FireModeNum) { EndFire(FireModeNum); DemoEndFire(FireModeNum); } /** * Like BeginFire, this function puts a client and the server in sync and shuts down the * firing sequence on both. * Network: LocalPlayer and Server */ simulated function EndFire(byte FireModeNum) { // Clear the firing flag for this mode ClearPendingFire(FireModeNum); } /** * Passes on EndFire calls to demos */ reliable demorecording function DemoEndFire(byte FireModeNum) { EndFire(FireModeNum); } /** * Clear all pending fires. * This is non replicated flag. */ simulated function ForceEndFire() { local int i; // Clear all pending fires for ( i=0; i<InvManager.PendingFire.Length; i++ ) { if( PendingFire(i) ) { EndFire(i); DemoEndFire(i); } } } /** * Send weapon to proper firing state * Also sets the CurrentFireMode. * Network: LocalPlayer and Server * * @param FireModeNum Fire Mode. */ simulated function SendToFiringState(byte FireModeNum) { // make sure fire mode is valid if( FireModeNum >= FiringStatesArray.Length ) { WeaponLog("Invalid FireModeNum", "Weapon::SendToFiringState"); return; } // Needs a state name, and ignores a none fire type if( FiringStatesArray[FireModeNum] == '' || WeaponFireTypes[FireModeNum] == EWFT_None ) { return; } // set current fire mode SetCurrentFireMode(FireModeNum); // transition to firing mode state GotoState(FiringStatesArray[FireModeNum]); } /** * Set current firing mode. * Network: Local Player and Server. */ simulated function SetCurrentFireMode(byte FiringModeNum) { // set weapon's current fire mode CurrentFireMode = FiringModeNum; // set on instigator, to replicate it to remote clients if( Instigator != None ) { Instigator.SetFiringMode(FiringModeNum); } } /** * Event called when Pawn.FiringMode has been changed. * bViaReplication indicates if this was the result of a replication call. */ simulated function FireModeUpdated(byte FiringMode, bool bViaReplication); /** * FireAmmunition: Perform all logic associated with firing a shot * - Fires ammunition (instant hit or spawn projectile) * - Consumes ammunition * - Plays any associated effects (fire sound and whatnot) * * Network: LocalPlayer and Server */ simulated function FireAmmunition() { // Use ammunition to fire ConsumeAmmo( CurrentFireMode ); // if this is the local player, play the firing effects PlayFiringSound(); // Handle the different fire types switch( WeaponFireTypes[CurrentFireMode] ) { case EWFT_InstantHit: InstantFire(); break; case EWFT_Projectile: ProjectileFire(); break; case EWFT_Custom: CustomFire(); break; } if( ( Instigator != None) && ( AIController(Instigator.Controller) != None ) ) { AIController(Instigator.Controller).NotifyWeaponFired(self,CurrentFireMode); } } /** * GetAdjustedAim begins a chain of function class that allows the weapon, the pawn and the controller to make * on the fly adjustments to where this weapon is pointing. */ simulated function Rotator GetAdjustedAim( vector StartFireLoc ) { local rotator R; // Start the chain, see Pawn.GetAdjustedAimFor() if( Instigator != None ) { R = Instigator.GetAdjustedAimFor( Self, StartFireLoc ); } return AddSpread(R); } /** * Range of weapon * Used for Traces (CalcWeaponFire, InstantFire, ProjectileFire, AdjustAim...) * State scoped accessor function. Override in proper state * * @return range of weapon, to be used mainly for traces. */ simulated function float GetTraceRange() { return WeaponRange; } /** @return the actor that 'owns' this weapon's traces (i.e. can't be hit by them) */ simulated function Actor GetTraceOwner() { return (Instigator != None) ? Instigator : self; } /** * CalcWeaponFire: Simulate an instant hit shot. * This doesn't deal any damage nor trigger any effect. It just simulates a shot and returns * the hit information, to be post-processed later. * * ImpactList returns a list of ImpactInfo containing all listed impacts during the simulation. * CalcWeaponFire however returns one impact (return variable) being the first geometry impact * straight, with no direction change. If you were to do refraction, reflection, bullet penetration * or something like that, this would return exactly when the crosshair sees: * The first 'real geometry' impact, skipping invisible triggers and volumes. * * @param StartTrace world location to start trace from * @param EndTrace world location to end trace at * @output ImpactList list of all impacts that occured during simulation * @return first 'real geometry' impact that occured. * * @note if an impact didn't occur, and impact is still returned, with its HitLocation being the EndTrace value. */ simulated function ImpactInfo CalcWeaponFire(vector StartTrace, vector EndTrace, optional out array<ImpactInfo> ImpactList) { local vector HitLocation, HitNormal, Dir; local Actor HitActor; local TraceHitInfo HitInfo; local ImpactInfo CurrentImpact; local PortalTeleporter Portal; local float HitDist; // Perform trace to retrieve hit info HitActor = GetTraceOwner().Trace(HitLocation, HitNormal, EndTrace, StartTrace, TRUE, vect(0,0,0), HitInfo, TRACEFLAG_Bullet); // If we didn't hit anything, then set the HitLocation as being the EndTrace location if( HitActor == None ) { HitLocation = EndTrace; } // Convert Trace Information to ImpactInfo type. CurrentImpact.HitActor = HitActor; CurrentImpact.HitLocation = HitLocation; CurrentImpact.HitNormal = HitNormal; CurrentImpact.RayDir = Normal(EndTrace-StartTrace); CurrentImpact.HitInfo = HitInfo; // Add this hit to the ImpactList ImpactList[ImpactList.Length] = CurrentImpact; // check to see if we've hit a trigger. // In this case, we want to add this actor to the list so we can give it damage, and then continue tracing through. if( HitActor != None ) { if (!HitActor.bBlockActors && PassThroughDamage(HitActor)) { // disable collision temporarily for the trigger so that we can catch anything inside the trigger HitActor.bProjTarget = false; // recurse another trace CurrentImpact = CalcWeaponFire(HitLocation, EndTrace, ImpactList); // and reenable collision for the trigger HitActor.bProjTarget = true; } else { // if we hit a PortalTeleporter, recurse through Portal = PortalTeleporter(HitActor); if( Portal != None && Portal.SisterPortal != None ) { Dir = EndTrace - StartTrace; HitDist = VSize(HitLocation - StartTrace); // calculate new start and end points on the other side of the portal StartTrace = Portal.TransformHitLocation(HitLocation); EndTrace = StartTrace + Portal.TransformVector(Normal(Dir) * (VSize(Dir) - HitDist)); //@note: intentionally ignoring return value so our hit of the portal is used for effects //@todo: need to figure out how to replicate that there should be effects on the other side as well CalcWeaponFire(StartTrace, EndTrace, ImpactList); } } } return CurrentImpact; } /** * returns true if should pass trace through this hitactor */ simulated function bool PassThroughDamage(Actor HitActor) { return HitActor.IsA('Trigger') || HitActor.IsA('TriggerVolume'); } /** * Performs an 'Instant Hit' shot. * Also, sets up replication for remote clients, * and processes all the impacts to deal proper damage and play effects. * * Network: Local Player and Server */ simulated function InstantFire() { local vector StartTrace, EndTrace; local Array<ImpactInfo> ImpactList; local int Idx; local ImpactInfo RealImpact; // define range to use for CalcWeaponFire() StartTrace = Instigator.GetWeaponStartTraceLocation(); EndTrace = StartTrace + vector(GetAdjustedAim(StartTrace)) * GetTraceRange(); // Perform shot RealImpact = CalcWeaponFire(StartTrace, EndTrace, ImpactList); if (Role == ROLE_Authority) { /* FlushPersistentDebugLines(); DrawDebugSphere( StartTrace, 10, 10, 0, 255, 0 ); DrawDebugSphere( EndTrace, 10, 10, 255, 0, 0 ); DrawDebugSphere( RealImpact.HitLocation, 10, 10, 0, 0, 255 ); `log( self@GetFuncName()@Instigator@RealImpact.HitLocation@RealImpact.HitActor );*/ // Set flash location to trigger client side effects. // if HitActor == None, then HitLocation represents the end of the trace (maxrange) // Remote clients perform another trace to retrieve the remaining Hit Information (HitActor, HitNormal, HitInfo...) // Here, The final impact is replicated. More complex bullet physics (bounce, penetration...) // would probably have to run a full simulation on remote clients. SetFlashLocation(RealImpact.HitLocation); } // Process all Instant Hits on local player and server (gives damage, spawns any effects). for (Idx = 0; Idx < ImpactList.Length; Idx++) { ProcessInstantHit(CurrentFireMode, ImpactList[Idx]); } } /** * Processes a successful 'Instant Hit' trace and eventually spawns any effects. * Network: LocalPlayer and Server * * @param HitActor Actor hit by trace * @param AimDir Aim direction of shot * @param HitLocation world location vector where HitActor was hit by trace * @param HitNormal hit normal vector * @param HitInto TraceHitInfo struct returning useful info like component hit, bone, material.. */ simulated function ProcessInstantHit( byte FiringMode, ImpactInfo Impact ) { if (Impact.HitActor != None) { Impact.HitActor.TakeDamage( InstantHitDamage[CurrentFireMode], Instigator.Controller, Impact.HitLocation, InstantHitMomentum[FiringMode] * Impact.RayDir, InstantHitDamageTypes[FiringMode], Impact.HitInfo, self ); } } /** * Fires a projectile. * Spawns the projectile, but also increment the flash count for remote client effects. * Network: Local Player and Server */ simulated function Projectile ProjectileFire() { local vector StartTrace, EndTrace, RealStartLoc, AimDir; local ImpactInfo TestImpact; local Projectile SpawnedProjectile; // tell remote clients that we fired, to trigger effects IncrementFlashCount(); if( Role == ROLE_Authority ) { // This is where we would start an instant trace. (what CalcWeaponFire uses) StartTrace = Instigator.GetWeaponStartTraceLocation(); AimDir = Vector(GetAdjustedAim( StartTrace )); // this is the location where the projectile is spawned. RealStartLoc = GetPhysicalFireStartLoc(AimDir); if( StartTrace != RealStartLoc ) { // if projectile is spawned at different location of crosshair, // then simulate an instant trace where crosshair is aiming at, Get hit info. EndTrace = StartTrace + AimDir * GetTraceRange(); TestImpact = CalcWeaponFire( StartTrace, EndTrace ); // Then we realign projectile aim direction to match where the crosshair did hit. AimDir = Normal(TestImpact.HitLocation - RealStartLoc); } // Spawn projectile SpawnedProjectile = Spawn(GetProjectileClass(), Self,, RealStartLoc); if( SpawnedProjectile != None && !SpawnedProjectile.bDeleteMe ) { SpawnedProjectile.Init( AimDir ); } // Return it up the line return SpawnedProjectile; } return None; } /** * If the weapon isn't an instant hit, or a simple projectile, it should use the tyoe EWFT_Custom. In those cases * this function will be called. It should be subclassed by the custom weapon. */ simulated function CustomFire(); /** * This function returns the world location for spawning the visual effects */ simulated event Vector GetMuzzleLoc() { if( Instigator != none ) { return Instigator.GetPawnViewLocation() + (FireOffset >> Instigator.GetViewRotation()); } return Location; } /** * This function returns the world location for spawning the projectile, pulled in to the Pawn's collision along the AimDir direction. */ simulated function vector GetPhysicalFireStartLoc(optional vector AimDir) { local float MuzzleDist; local vector MuzzleLoc, PulledInMuzzleLoc, ExtraPullIn; MuzzleLoc = GetMuzzleLoc(); if ( (Instigator == None) || (AimDir == vect(0,0,0)) ) return MuzzleLoc; // is muzzle outside pawn's collision cylinder? MuzzleDist = VSize2D(MuzzleLoc - Instigator.Location); if ( MuzzleDist > Instigator.CylinderComponent.CollisionRadius ) { // pull MuzzleLoc back toward cylinder PulledInMuzzleLoc = MuzzleLoc - MuzzleDist * AimDir; MuzzleDist = VSize2D(PulledInMuzzleLoc - Instigator.Location); if ( MuzzleDist < Instigator.CylinderComponent.CollisionRadius ) { MuzzleLoc = PulledInMuzzleLoc; } else { ExtraPullIn = Instigator.Location - PulledInMuzzleLoc; ExtraPullIn.Z = 0; ExtraPullIn = (2.0 + MuzzleDist - Instigator.CylinderComponent.CollisionRadius) * Normal(ExtraPullIn); MuzzleLoc = PulledInMuzzleLoc + ExtraPullIn; } } return MuzzleLoc; } /** * Put Down current weapon * Once the weapon is put down, the InventoryManager will switch to InvManager.PendingWeapon. * * @return returns true if the weapon can be put down. */ simulated function bool TryPutDown() { bWeaponPutDown = TRUE; return TRUE; } /********************************************************************************************* * State Inactive * Default state for a weapon. It is not active, cannot fire and resides in player inventory. *********************************************************************************************/ auto state Inactive { /** * Clear out the PendingFires */ simulated event BeginState( Name PreviousStateName ) { // // Make sure all pending fires are cleared // ForceEndFire(); } reliable server function ServerStartFire( byte FireModeNum ) { if (Instigator != none && Instigator.Weapon == self) // We haven't received the activate yet so pass it along { GotoState('Active'); Global.ServerStartFire(FireModeNum); } else if (InvManager != none && InvManager.PendingWeapon == self) { InvManager.ChangedWeapon(); SetPendingFire(FireModeNum); } else if (Instigator != None) { //`log("# - Attempting to sync up the weapon"); // Have the client switch to the current weapon InvManager.ClientSyncWeapon(Instigator.Weapon); } } reliable server function ServerStopFire( byte FireModeNum ) { ClearPendingFire(FireModeNum); } /** do not allow firing in the inactive state */ simulated function StartFire( byte FireModeNum ); /** can't put down an inactive weapon */ simulated function bool TryPutDown() { return FALSE; } } /********************************************************************************************* * State Active * A Weapon this is being held by a pawn should be in the active state. In this state, * a weapon should loop any number of idle animations, as well as check the PendingFire flags * to see if a shot has been fired. *********************************************************************************************/ simulated state Active { /** Initialize the weapon as being active and ready to go. */ simulated event BeginState(Name PreviousStateName) { local int i; // Check to see if we need to go down if( bWeaponPutDown ) { PutDownWeapon(); } else if ( !HasAnyAmmo() ) { WeaponEmpty(); } else { // if either of the fire modes are pending, perform them for( i=0; i<InvManager.PendingFire.Length; i++ ) { if( PendingFire(i) ) { BeginFire(i); DemoBeginFire(i); break; } } } } /** Override BeginFire so that it will enter the firing state right away. */ simulated function BeginFire(byte FireModeNum) { if( !bDeleteMe && Instigator != None ) { Global.BeginFire(FireModeNum); // in the active state, fire right away if we have the ammunition if( PendingFire(FireModeNum) && HasAmmo(FireModeNum) ) { SendToFiringState(FireModeNum); } } } /** * ReadyToFire() called by NPC firing weapon. bFinished should only be true if called from the Finished() function */ simulated function bool ReadyToFire(bool bFinished) { return true; } /** Activate() ignored since already active */ simulated function Activate() { } /** * Put the weapon down */ simulated function bool TryPutDown() { PutDownWeapon(); return TRUE; } } /********************************************************************************************* * state WeaponFiring * This is the default Firing State. It's performed on both the client and the server. *********************************************************************************************/ simulated state WeaponFiring { simulated event bool IsFiring() { return true; } /** * Timer event, call is set up in Weapon::TimeWeaponFiring(). * The weapon is given a chance to evaluate if another shot should be fired. * This event defines the weapon's rate of fire. */ simulated function RefireCheckTimer() { // if switching to another weapon, abort firing and put down right away if( bWeaponPutDown ) { PutDownWeapon(); return; } // If weapon should keep on firing, then do not leave state and fire again. if( ShouldRefire() ) { FireAmmunition(); return; } // Otherwise we're done firing, so go back to active state. GotoState('Active'); } simulated event BeginState( Name PreviousStateName ) { // Fire the first shot right away FireAmmunition(); TimeWeaponFiring( CurrentFireMode ); } simulated event EndState( Name NextStateName ) { // Set weapon as not firing ClearFlashCount(); ClearFlashLocation(); ClearTimer('RefireCheckTimer'); if (Instigator != none && AIController(Instigator.Controller) != None) { AIController(Instigator.Controller).NotifyWeaponFinishedFiring(self,CurrentFireMode); } } } /** * Check if current fire mode can/should keep on firing. * This is called from a firing state after each shot is fired * to decide if the weapon should fire again, or stop and go to the active state. * The default behavior, implemented here, is keep on firing while player presses fire * and there is enough ammo. (Auto Fire). * * @return true to fire again, false to stop firing and return to Active State. */ simulated function bool ShouldRefire() { // if doesn't have ammo to keep on firing, then stop if( !HasAmmo( CurrentFireMode ) ) { return false; } // refire if owner is still willing to fire return StillFiring( CurrentFireMode ); } /** * This function returns true if the weapon is still firing in a given mode */ simulated function bool StillFiring(byte FireMode) { return ( PendingFire(FireMode) ); } /** * State WeaponEquipping * The Weapon is in this state while transitioning from Inactive to Active state. * Typically, the weapon will remain in this state while its selection animation is being played. * While in this state, the weapon cannot be fired. */ simulated state WeaponEquipping { simulated event BeginState(Name PreviousStateName) { TimeWeaponEquipping(); bWeaponPutDown = false; } /** Activate() ignored since already becoming active */ simulated function Activate() { } simulated event EndState(Name NextStateName) { ClearTimer('WeaponEquipped'); } simulated function WeaponEquipped() { if( bWeaponPutDown ) { // if switched to another weapon, put down right away PutDownWeapon(); return; } GotoState('Active'); } } /** * State WeaponPuttingDown * Putting down weapon in favor of a new one. * Weapon is transitioning to the Inactive state. */ simulated state WeaponPuttingDown { /** * Time the process and clear the Firing flags */ simulated event BeginState(Name PreviousStateName) { TimeWeaponPutDown(); bWeaponPutDown = FALSE; // Make sure all pending fires are cleared. ForceEndFire(); } /** * We are done putting the weapon away, remove the mesh/etc. */ simulated function WeaponIsDown() { if( InvManager.CancelWeaponChange() ) { return; } // This weapon is down, remove it from the mesh DetachWeapon(); // Put weapon to sleep //@warning: must be before ChangedWeapon() because that can reactivate this weapon in some cases GotoState('Inactive'); // switch to pending weapon InvManager.ChangedWeapon(); } simulated function bool TryPutDown() { return FALSE; } simulated event EndState(Name NextStateName) { ClearTimer('WeaponIsDown'); } } /********************************************************************************************* * State PendingClientWeaponSet * A weapon sets in this state on a remote client while it awaits full replication of all * properties. *********************************************************************************************/ State PendingClientWeaponSet { simulated function PendingWeaponSetTimer() { // When variables are replicated, ClientWeaponSet, will send weapon to another state. // Therefore aborting this timer. ClientWeaponSet( true ); } /** Event called when weapon enters this state */ simulated event BeginState(Name PreviousStateName) { // Set a timer to keep checking for replicated variables. SetTimer(0.05, true, 'PendingWeaponSetTimer'); } /** Event called when weapon leaves this state */ simulated event EndState(Name NextStateName) { ClearTimer('PendingWeaponSetTimer'); } } /** * Passes on BeginFire calls to demos */ reliable demorecording function DemoBeginFire(byte FireModeNum) { BeginFire(FireModeNum); } defaultproperties { EquipTime=0.330000 PutDownTime=0.330000 bCanThrow=True WeaponRange=16384.000000 DefaultAnimSpeed=1.000000 Priority=-1.000000 AIRating=0.500000 ItemName="Weapon" RespawnTime=30.000000 bReplicateInstigator=True bOnlyDirtyReplication=False Name="Default__Weapon" ObjectArchetype=Inventory'Engine.Default__Inventory' } |
Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |