Files
UT99-Mod-IChaChaMutEngine/Classes/ICCME_Event_Game_PotentialGameEnded.uc
2023-05-24 17:01:45 +01:00

59 lines
2.5 KiB
Ucode

class ICCME_Event_Game_PotentialGameEnded extends ICCME_Event_GameBase;
// ============================================================================
// Arg Name: bManagedOverTime
// Type: Boolean
// ----------------------------------------------------------------------------
// This variable indicate if the current event comes from a Managed OverTime
// detection.
// /!\ To use it user must have bEnableOvertimeControl set to true in
// ChaChaMutatorEngine.ini.
// ----------------------------------------------------------------------------
var bool bManagedOverTime;
// ----------------------------------------------------------------------------
// ============================================================================
// Arg Name: bEndGame
// Type: Boolean
// ----------------------------------------------------------------------------
// This variable is both an indicator and a control value. The initial value is
// what the Engine is going to do but Modder can change it in its own Mut.
//
// /!\ This variable has two close but different meanings
// de pending on bManagedOverTime:
//
// * If bManagedOverTime is True:
// Then bEndGame is controlling ChaChaMutEngine Own OverTime.
// => That mean you can set it to True to force not having OverTime, or False to
// not have one.
// /!\ CCME's OverTime can only be triggered once, Then at any Valid score
// encoutered, the engine will stop game / display score.
//
// * If bManagedOverTime is False:
// Then bEndGame is bind to the HandleEndGame() function from standard Mutator
// API. In such case, modders can use bManagedOverTime to fast-close a
// challenge. The main UT's engine calls this function at every end-Score
// (during normal gameplay, either when goal score reached, or if time limit
// reached), or at any score during overtime.
// This is the reason ManagedOverTime exists in CCME: The internal
// implementation does not let us choose when to refuse ac end-score and force
// to go in OverTime. It only let use the opportunity to fast quit The
// challenge.
// => That mean you can instant close game / no end score display,
// by setting this variable to True when you receive it.
// ----------------------------------------------------------------------------
var bool bEndGame;
// ----------------------------------------------------------------------------
function doLog()
{
super.doLog();
log("bManagedOverTime:"@bManagedOverTime);
log("bEndGame:"@bEndGame);
}
defaultproperties
{
bEndGame=True
}