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

KFStoryGame.HUD_StoryMode

Extends
HUDKillingFloorSP
Modifiers
dependson ( KFStoryGameInfo )

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Hud
      |   
      +-- XInterface.HudBase
         |   
         +-- KFMod.HUDKillingFloor
            |   
            +-- KFMod.HUDKillingFloorSP
               |   
               +-- KFStoryGame.HUD_StoryMode

Variables Summary
array<KF_StoryObjective>AllObjs
boolbCollapseConditions
boolbFadingIn
boolbFadingOut
boolbFadingOutObj
boolbInstantObjTransitions
boolbPendingFadeOut
boolbPlayedIntroMovie
boolbPlayingIntroMovie
boolbShowObjectives
boolbSkipTransitions
array<SConditionHint>ConditionHints
intCurrentDlgIndex
KF_StoryObjectiveCurrentObj
SpriteWidgetDialogueBackground
RelativeCoordsInfoDialogueCoords
array<SDialogueRenderInfo>Dialogues
array<KF_DialogueSpot>DialogueSpots
TextWidgetDialogueTextWidget
TextWidgetDialogueTitleWidget
array<KF_StoryObjective>HUDObjs
KF_HUDStyleManagerHUDStyleManager
LobbyMenuAdIntro_BinkMovie
floatlastConditionupdateTime
floatLastHUDRenderTime
floatLastIconUpdateTime
floatLastNewRenderObjTime
KFShopDirectionPointerObjectiveArrow
floatObjFadeInTime
floatObjFadeOutDelay
floatObjFadeOutTime
intObjRenderIdx
floatPendingFadeOutStartTime
floatRenderDelta
KF_StoryObjectiveRenderObj
floatRenderObjOpacity
KF_StoryGRISGRI
intStoryIconOffsetX
intStoryIconOffsetY
array<string>WrappedDialogue
Inherited Variables from KFMod.HUDKillingFloor
ArmorBG, ArmorDigits, ArmorIcon, ArmorIconSize, ArrowheadIcon, BarHeight, BarLength, bDebugPlayerCollision, bDisplayDeathScreen, bDisplayInventory, bDisplayQuickSyringe, bDrawDoorHealth, bDrawHint, bFirstHintRender, bGetNewSub, bHint_45_TimeSet, bInitialDark, bInventoryFadingIn, bInventoryFadingOut, bIsSecondDowntime, bLightHud, BorderSize, bShowBuddyDebug, bShowEnemyDebug, bShowKFDebugXHair, bShowMapUpdatedText, bShowNotification, bTallySpecimenKills, bTicksTurn, BulletsInClipBG, BulletsInClipDigits, BulletsInClipIcon, bUsingVOIP, bZoneChanged, CashDigits, CashIcon, ClipsBG, ClipsDigits, ClipsIcon, CurAmmoPrimary, CurClipsPrimary, CurClipsSecondary, CurrentB, CurrentG, CurrentR, CurrentVolume, CurrentZone, DamageHUDTimer, DamageIsUber, DamageStartTime, DigitsBig, DigitsSmall, DistanceUnitString, DoorCache, DoorMover, DoorWelderBG, DoorWelderIcon, EndGameHUDTime, EnemyHealthBarHeight, EnemyHealthBarLength, FadeColor, FadeTime, FireOverlay, FlameIcon, FlameTankIcon, FlashlightBG, FlashlightDigits, FlashlightIcon, FlashlightOffIcon, Global_Delta, GoalTarget, GrainAlpha, GrenadeBG, GrenadeDigits, GrenadeIcon, HealthBarCutoffDist, HealthBarFullVisDist, HealthBG, HealthDigits, HealthIcon, HealthIconSize, HintBackground, HintCoords, HintDesiredAspectRatio, HintFadeTime, HintLifetime, HintRemainingTime, HintText, HintTextWidget, HintTitle, HintTitleWidget, HintWrappedText, Hint_45_Time, HUDHitDamage, hudLastRenderTime, HuskAmmoIcon, IntroTitleFade, InventoryBackgroundTexture, InventoryBoxHeight, InventoryBoxWidth, InventoryFadeStartTime, InventoryFadeTime, InventoryX, InventoryY, KFGRI, KFHUDAlpha, KFLevelRule, KFPRI, LastB, LastDoorBarHealthUpdate, LastG, LastR, LastSubChangeTime, LastVolume, LastWeaponMat, LastZone, LawRocketIcon, LevelActionFontColor, LevelActionFontFont, LevelActionPositionX, LevelActionPositionY, M79Icon, MaxAmmoPrimary, MedicGunBG, MedicGunDigits, MedicGunIcon, MenuFontArrayFonts[5], MenuFontArrayNames[5], MessageHealthLimit, MessageMassLimit, MyColorMod, NearDeathOverlay, NeedleRotator, NextModLogTime, NextStatsUdpTime, NotificationBackground, NotificationBorderSize, NotificationFontSize, NotificationHeight, NotificationHideDelay, NotificationHideTime, NotificationIcon, NotificationIconSpacing, NotificationPhase, NotificationPhaseStartTime, NotificationShowTime, NotificationString, NotificationWidth, NumCalls, OverlayFadeSpeed, PipeBombIcon, PlayerGrenade, PlayerInfoPawns, Portrait, PortraitTime, PortraitX, QuickSyringeBG, QuickSyringeDigits, QuickSyringeDisplayTime, QuickSyringeFadeInTime, QuickSyringeFadeOutTime, QuickSyringeIcon, QuickSyringeStartTime, SawAmmoIcon, SecondaryClipsBG, SecondaryClipsDigits, SecondaryClipsIcon, SelectedInventory, SelectedInventoryBackgroundTexture, SelectedInventoryCategory, SelectedInventoryIndex, ShopDirPointer, SingleBulletIcon, SmallFontArrayFonts[9], SmallFontArrayNames[9], SpectatorOverlay, SubIndex, Subtitle, SwitchDigitColorTime, SyringeBG, SyringeDigits, SyringeIcon, TraderPortrait, TraderString, ValueCheckOut, VeterancyMatScaleFactor, VetStarGoldMaterial, VetStarMaterial, VetStarSize, VisionOverlay, VoiceMeterBackground, VoiceMeterSize, VoiceMeterX, VoiceMeterY, VomitHudTimer, WaitingFontArrayFonts[3], WaitingFontArrayNames[3], WaveString, WeightBG, WeightDigits, WeightIcon, WelderBG, WelderDigits, WelderIcon, WeldIntegrityString, WeldText, WhiteFlashTime, WhiteMaterial, ZEDAmmoIcon

Structures Summary
SConditionHint
ConditionName, DataString, WorldHint, bComplete, ProgressPct, ProgressBar_Clr, World_Clr, ConditionType, HintStyle, DisplayStyle, ConditionLoc, WorldTex, Material_ProgressBarFill, Material_ProgressBarBG, FontScale, bHideWorld, bIgnoreWorldHidden, LastProgressUpdateTime, LastProgressVal, WidestDataX, ProgBarheight, HintWidth, HintHeight, ObjOwner, bShowCheckBox, bShowStrikeThrough, World_Texture_Scale, PendingLocActorTag
SDialogueRenderInfo
Speaker, Message, Duration, Portrait, FirstDisplayedTime, Opacity, bWrapped, bFirstDisplay, ScreenPos, ScreenAlignment, BinkPortrait, BackGroundMat, ScreenScaleStyle
Inherited Structures from KFMod.HUDKillingFloor
AbsoluteCoordsInfo, InventoryCategory, PlayerInfoPawnType, RelativeCoordsInfo, TextWidget

Functions Summary
function AddDialogue (name DialogueActorName, int DlgIndex, float DisplayDuration))
function AddHUDObjective (KF_StoryObjective NewObj))
function AddNewConditionHint (KF_ObjectiveCondition NewCondition, name NewOwner, float NewProgressPct, Actor NewLocActor, string NewDataString, bool bComplete, name PendingLocActorTag))
functionbool ApplyConditionStylePresets (int Index))
function ApplyDialogueStylePresets (KF_DialogueSpot NewDlg, int DlgIndex))
function ApplyObjectiveStylePresets (KF_StoryObjective NewObj))
function CacheDialogueActors ()))
function CacheObjectives ()))
function CalculateDialogueWrappingData (Canvas Canvas))
function CanvasDrawActors (Canvas C, bool bClearedZBuffer ))
function DrawDialogue (Canvas C))
function DrawEndGameHUD (Canvas C, bool bVictory))
function DrawHUD (Canvas Canvas))
function DrawHudPassA (Canvas C))
function DrawObjectiveHints (Canvas C, KF_StoryObjective CurrentObj, float FadeValue))
function DrawObjectiveInfo (Canvas C))
function DrawObjWorldIcons (Canvas C))
function DrawSpectatingHud (Canvas C))
function DrawStoryDebugInfo (Canvas Canvas))
function DrawStoryHUDInfo (Canvas C))
functionKF_ObjectiveCondition FindConditionByName (name ConditionName))
functionbool FindConditionTypeFor (SConditionHint TestCondition, out byte ConditionType))
functionKF_DialogueSpot FindDialogueActor (name DlgName))
functionbool FindExistingCondition (name ConditionName, out Int Index))
functionbool FindExistingDialogue (string text, optional out int Index))
functionKF_StoryObjective FindHUDObjective (name TestObj, optional out int i))
functionKF_StoryObjective FindObjectiveByName (name TestObj, optional out int i))
functionMaterial GetCheckBoxMaterialFor (SConditionHint Testcondition))
function Message (PlayerReplicationInfo PRI, coerce string Msg, name MsgType))
function ObjFadeInComplete ()))
function ObjFadeOutComplete ()))
event PostBeginPlay ()))
function PostRenderStoryInventory (Canvas C))
function RemoveConditionHint (name HintToRemove))
function RemoveHUDObjective (KF_StoryObjective RemoveObj))
function RenderIntroMovie (Canvas C))
function RenderStoryItems (Canvas C))
functionfloat ResolveFontResolution (Canvas C, optional int FontScale))
function ResolveObjectiveInfo ()))
function SetObjX (float X))
function SetObjY (float Y))
functionbool ShouldRenderCondition (SConditionHint TestCondition, string Type))
function ShowDebug ()))
function Tick (float DeltaTime))
function ToggleObjectiveHUD ()))
function UpdateConditionHint (name UpdatedCondition, name NewOwner, float NewProgressPct, Actor NewLocActor, string NewDataString, bool NewComplete, name PendingLocActorTag))
function UpdateObjFadeVals (float DeltaTime))
functionVector VInterpTo (Vector Current, Vector Target, FLOAT DeltaTime, FLOAT InterpSpeed))
Inherited Functions from KFMod.HUDKillingFloorSP
DrawKFHUDTextElements
Inherited Functions from KFMod.HUDKillingFloor
CalcPivotCoords, CalculateAmmo, CalculateHintWrappingData, CanvasDrawActors, Destroyed, DisplayHit, DisplayMessages, DisplayPortrait, DisplayProgressMessages, DisplayTraderPortrait, DisplayVoiceGain, DrawBuddyInfo, DrawCinematicHUD, DrawCrosshair, DrawCustomBeacon, DrawDamageIndicators, DrawDebugCylinder, DrawDoorBar, DrawDoorHealthBars, DrawEndGameHUD, DrawEnemyInfo, DrawFadeEffect, DrawHealthBar, DrawHint, DrawHud, DrawHudPassA, DrawHudPassC, DrawInventory, DrawKFBar, DrawKFHUDTextElements, DrawLevelAction, DrawModOverlay, DrawPlayerInfo, DrawPointSphere, DrawPopupNotification, DrawPortrait, DrawSpectatingHud, DrawStayingDebugCircle, DrawStayingDebugSphere, DrawSubtitle, DrawTextWidgetClipped, DrawTraderDistance, DrawTypingPrompt, DrawWeaponName, FindPlayerGrenade, ForceFadeEffect, GetLargeMenuFont, GetSmallerMenuFont, GetSmallMenuFont, GetWaitingFontSizeIndex, HideInventory, HideScores, LayoutMessage, LoadLevelActionFont, LoadMenuFontStatic, LoadSmallFontStatic, LoadWaitingFont, Message, NextWeapon, PostBeginPlay, PostRender, PrevWeapon, SelectWeapon, SetHUDAlpha, ShowDebug, ShowHint, ShowHud, ShowInventory, ShowPopupNotification, ShowQuickSyringe, StartFadeEffect, StopFadeEffect, Strl, Tick, Timer, UpdateHud, UpdateKillMessage


Variables Detail

AllObjs Source code

var array<KF_StoryObjective> AllObjs;

bCollapseConditions Source code

var bool bCollapseConditions;

bFadingIn Source code

var bool bFadingIn;

bFadingOut Source code

var bool bFadingOut;

bFadingOutObj Source code

var bool bFadingOutObj;

bInstantObjTransitions Source code

var bool bInstantObjTransitions;

bPendingFadeOut Source code

var bool bPendingFadeOut;

bPlayedIntroMovie Source code

var bool bPlayedIntroMovie;

bPlayingIntroMovie Source code

var bool bPlayingIntroMovie;

bShowObjectives Source code

var bool bShowObjectives;

bSkipTransitions Source code

var bool bSkipTransitions;

ConditionHints Source code

var array<SConditionHint> ConditionHints;

CurrentDlgIndex Source code

var int CurrentDlgIndex;

CurrentObj Source code

var KF_StoryObjective CurrentObj;

DialogueBackground Source code

var SpriteWidget DialogueBackground;

DialogueCoords Source code

var RelativeCoordsInfo DialogueCoords;

Dialogues Source code

var array<SDialogueRenderInfo> Dialogues;

DialogueSpots Source code

var array<KF_DialogueSpot> DialogueSpots;

DialogueTextWidget Source code

var TextWidget DialogueTextWidget;

DialogueTitleWidget Source code

var TextWidget DialogueTitleWidget;

HUDObjs Source code

var array<KF_StoryObjective> HUDObjs;

HUDStyleManager Source code

var KF_HUDStyleManager HUDStyleManager;

Intro_BinkMovie Source code

var LobbyMenuAd Intro_BinkMovie;

lastConditionupdateTime Source code

var float lastConditionupdateTime;

LastHUDRenderTime Source code

var float LastHUDRenderTime;

LastIconUpdateTime Source code

var float LastIconUpdateTime;

LastNewRenderObjTime Source code

var float LastNewRenderObjTime;

ObjectiveArrow Source code

var KFShopDirectionPointer ObjectiveArrow;

ObjFadeInTime Source code

var float ObjFadeInTime;

ObjFadeOutDelay Source code

var float ObjFadeOutDelay;

ObjFadeOutTime Source code

var float ObjFadeOutTime;

ObjRenderIdx Source code

var int ObjRenderIdx;

PendingFadeOutStartTime Source code

var float PendingFadeOutStartTime;

RenderDelta Source code

var float RenderDelta;

RenderObj Source code

var KF_StoryObjective RenderObj;

RenderObjOpacity Source code

var float RenderObjOpacity;

SGRI Source code

var KF_StoryGRI SGRI;

StoryIconOffsetX Source code

var int StoryIconOffsetX;

StoryIconOffsetY Source code

var int StoryIconOffsetY;

WrappedDialogue Source code

var array<string> WrappedDialogue;


Structures Detail

SConditionHint Source code

struct SConditionHint
{
var int bComplete;
var bool bHideWorld;
var bool bIgnoreWorldHidden;
var bool bShowCheckBox;
var bool bShowStrikeThrough;
var Actor ConditionLoc;
var name ConditionName;
var byte ConditionType;
var string DataString;
var byte DisplayStyle;
var int FontScale;
var float HintHeight;
var byte HintStyle;
var float HintWidth;
var float LastProgressUpdateTime;
var float LastProgressVal;
var Material Material_ProgressBarBG;
var Material Material_ProgressBarFill;
var name ObjOwner;
var name PendingLocActorTag;
var float ProgBarheight;
var color ProgressBar_Clr;
var float ProgressPct;
var float WidestDataX;
var string WorldHint;
var Material WorldTex;
var color World_Clr;
var float World_Texture_Scale;
};


SDialogueRenderInfo Source code

struct SDialogueRenderInfo
{
var Material BackGroundMat;
var bool bFirstDisplay;
var LobbyMenuAd BinkPortrait;
var bool bWrapped;
var float Duration;
var float FirstDisplayedTime;
var string Message;
var float Opacity;
var Material Portrait;
var KFStoryGameInfo.EDialogueAlignment ScreenAlignment;
var KFStoryGameInfo.SVect2D ScreenPos;
var KFStoryGameInfo.EDialogueScaleStyle ScreenScaleStyle;
var string Speaker;
};



Functions Detail

AddDialogue Source code

simulated function AddDialogue ( name DialogueActorName, int DlgIndex, float DisplayDuration) )

AddHUDObjective Source code

simulated function AddHUDObjective ( KF_StoryObjective NewObj) )

AddNewConditionHint Source code

simulated function AddNewConditionHint ( KF_ObjectiveCondition NewCondition, name NewOwner, float NewProgressPct, Actor NewLocActor, string NewDataString, bool bComplete, name PendingLocActorTag) )

ApplyConditionStylePresets Source code

simulated function bool ApplyConditionStylePresets ( int Index) )

ApplyDialogueStylePresets Source code

simulated function ApplyDialogueStylePresets ( KF_DialogueSpot NewDlg, int DlgIndex) )

ApplyObjectiveStylePresets Source code

simulated function ApplyObjectiveStylePresets ( KF_StoryObjective NewObj) )

CacheDialogueActors Source code

simulated function CacheDialogueActors ( ) )

CacheObjectives Source code

simulated function CacheObjectives ( ) )

CalculateDialogueWrappingData Source code

function CalculateDialogueWrappingData ( Canvas Canvas) )

CanvasDrawActors Source code

function CanvasDrawActors ( Canvas C, bool bClearedZBuffer ) )

DrawDialogue Source code

simulated function DrawDialogue ( Canvas C) )

DrawEndGameHUD Source code

simulated function DrawEndGameHUD ( Canvas C, bool bVictory) )

DrawHUD Source code

simulated function DrawHUD ( Canvas Canvas) )

DrawHudPassA Source code

simulated function DrawHudPassA ( Canvas C) )

DrawObjectiveHints Source code

simulated final function DrawObjectiveHints ( Canvas C, KF_StoryObjective CurrentObj, float FadeValue) )

DrawObjectiveInfo Source code

simulated function DrawObjectiveInfo ( Canvas C) )

DrawObjWorldIcons Source code

simulated function DrawObjWorldIcons ( Canvas C) )

DrawSpectatingHud Source code

simulated function DrawSpectatingHud ( Canvas C) )

DrawStoryDebugInfo Source code

simulated function DrawStoryDebugInfo ( Canvas Canvas) )

DrawStoryHUDInfo Source code

simulated function DrawStoryHUDInfo ( Canvas C) )

FindConditionByName Source code

function KF_ObjectiveCondition FindConditionByName ( name ConditionName) )

FindConditionTypeFor Source code

simulated function bool FindConditionTypeFor ( SConditionHint TestCondition, out byte ConditionType) )

FindDialogueActor Source code

simulated function KF_DialogueSpot FindDialogueActor ( name DlgName) )

FindExistingCondition Source code

simulated function bool FindExistingCondition ( name ConditionName, out Int Index) )

FindExistingDialogue Source code

simulated function bool FindExistingDialogue ( string text, optional out int Index) )

FindHUDObjective Source code

simulated function KF_StoryObjective FindHUDObjective ( name TestObj, optional out int i) )

FindObjectiveByName Source code

simulated function KF_StoryObjective FindObjectiveByName ( name TestObj, optional out int i) )

GetCheckBoxMaterialFor Source code

simulated function Material GetCheckBoxMaterialFor ( SConditionHint Testcondition) )

Message Source code

simulated function Message ( PlayerReplicationInfo PRI, coerce string Msg, name MsgType) )

ObjFadeInComplete Source code

simulated function ObjFadeInComplete ( ) )

ObjFadeOutComplete Source code

simulated function ObjFadeOutComplete ( ) )

PostBeginPlay Source code

simulated event PostBeginPlay ( ) )

PostRenderStoryInventory Source code

function PostRenderStoryInventory ( Canvas C) )

RemoveConditionHint Source code

simulated function RemoveConditionHint ( name HintToRemove) )

RemoveHUDObjective Source code

simulated function RemoveHUDObjective ( KF_StoryObjective RemoveObj) )

RenderIntroMovie Source code

simulated function RenderIntroMovie ( Canvas C) )

RenderStoryItems Source code

simulated function RenderStoryItems ( Canvas C) )

ResolveFontResolution Source code

simulated function float ResolveFontResolution ( Canvas C, optional int FontScale) )

ResolveObjectiveInfo Source code

simulated function ResolveObjectiveInfo ( ) )

SetObjX Source code

exec simulated function SetObjX ( float X) )

SetObjY Source code

exec simulated function SetObjY ( float Y) )

ShouldRenderCondition Source code

simulated function bool ShouldRenderCondition ( SConditionHint TestCondition, string Type) )

ShowDebug Source code

exec function ShowDebug ( ) )

Tick Source code

simulated function Tick ( float DeltaTime) )

ToggleObjectiveHUD Source code

exec simulated function ToggleObjectiveHUD ( ) )

UpdateConditionHint Source code

simulated function UpdateConditionHint ( name UpdatedCondition, name NewOwner, float NewProgressPct, Actor NewLocActor, string NewDataString, bool NewComplete, name PendingLocActorTag) )

UpdateObjFadeVals Source code

simulated function UpdateObjFadeVals ( float DeltaTime) )

VInterpTo Source code

simulated function Vector VInterpTo ( Vector Current, Vector Target, FLOAT DeltaTime, FLOAT InterpSpeed) )
Interpolate vector from Current to Target with constant step


Defaultproperties

defaultproperties
{
     ObjFadeOutTime=0.500000
     ObjFadeInTime=0.500000
     ObjFadeOutDelay=1.000000
     bShowObjectives=True
     DialogueBackground=(WidgetTexture=Texture'KF_InterfaceArt_tex.Menu.Med_border_SlightTransparent',RenderStyle=STY_Alpha,DrawPivot=DP_MiddleMiddle,PosY=0.020000,ScaleMode=SM_Left,Scale=1.000000,Tints[0]=(B=255,G=255,R=255,A=192),Tints[1]=(B=255,G=255,R=255,A=192))
     DialogueTitleWidget=(RenderStyle=STY_Alpha,WrapHeight=1.000000,OffsetX=15,OffsetY=15,bDrawShadow=True,Tints[0]=(B=255,G=255,R=255,A=255),Tints[1]=(B=255,G=255,R=255,A=255))
     DialogueTextWidget=(RenderStyle=STY_Alpha,WrapHeight=1.000000,OffsetX=15,OffsetY=45,Tints[0]=(B=255,G=255,R=255,A=255),Tints[1]=(B=255,G=255,R=255,A=255))
     DialogueCoords=(X=0.500000,Y=0.600000,XL=-1.000000)
     StoryIconOffsetX=20
     StoryIconOffsetY=50
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: Fri 13-10-2023 03:18:45.646 - Created with UnCodeX