HPL3/Amnesia: Rebirth/Scripting/cLuxDialogHandler

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

cLuxDialogHandler has no public fields.

Functions

Return Type	Function And Description
void	AddBranch(const tString &in asName, const tString &in asNextBranch)
void	AddBranchEvent(eLuxDialogBranchEvent aType, float afVar, const tString &in asVar, const tString &in asNewBranch, bool abOnlyCheckEndOfSubject)
void	AddBranchPause(float afTime, const tString &in asCallback)
void	AddBranchSubject(const tString &in asSubject, const tString &in asCallback)
void	AddResponseCondition(eLuxDialogOptionCondition aCondition, const tString &in asVarName, int alValue)
void	AddResponseEvent(eLuxDialogOptionEvent aEvent, const tString &in asVarName, int alValue)
void	AddResponseOption(const tString &in asEntry, const tString &in asBranch, int alId, const tString &in asCallback)
void	Begin(const tString &in asName)
bool	CharacterIsActive(const tString &in asName)
void	End(const tString &in asStartBranch)
tString	GetCharacterScene(const tString &in asCharacterName)
void	GetCharactersInSubject(const tString &in asSubject, array<tString> avOutCharacters)
int	GetVar(const tString &in asName)
void	IncVar(const tString &in asName, int alX)
void	ReturnResponseSelectChoice(int alSelectedOption)
void	SetCallbackFunc(const tString &in asFunc)
void	SetResponseTimeLimit(float afTime)
void	SetVar(const tString &in asName, int alX)
void	Stop(const tString &in asName)
void	StopAll()

Details

AddBranch

void AddBranch(const tString &in asName,
               const tString &in asNextBranch)

Parameters

• asName (tString) —
• asNextBranch (tString) —

Returns:

• void

AddBranchEvent

void AddBranchEvent(eLuxDialogBranchEvent aType,
                    float afVar,
                    const tString &in asVar,
                    const tString &in asNewBranch,
                    bool abOnlyCheckEndOfSubject)

Parameters

• aType (eLuxDialogBranchEvent) —
• afVar (float) —
• asVar (tString) —
• asNewBranch (tString) —
• abOnlyCheckEndOfSubject (bool) —

Returns:

• void

AddBranchPause

void AddBranchPause(float afTime,
                    const tString &in asCallback)

Parameters

• afTime (float) —
• asCallback (tString) —

Returns:

• void

AddBranchSubject

void AddBranchSubject(const tString &in asSubject,
                      const tString &in asCallback)

Parameters

• asSubject (tString) —
• asCallback (tString) —

Returns:

• void

AddResponseCondition

void AddResponseCondition(eLuxDialogOptionCondition aCondition,
                          const tString &in asVarName,
                          int alValue)

Parameters

• aCondition (eLuxDialogOptionCondition) —
• asVarName (tString) —
• alValue (int) —

Returns:

• void

AddResponseEvent

void AddResponseEvent(eLuxDialogOptionEvent aEvent,
                      const tString &in asVarName,
                      int alValue)

Parameters

• aEvent (eLuxDialogOptionEvent) —
• asVarName (tString) —
• alValue (int) —

Returns:

• void

AddResponseOption

void AddResponseOption(const tString &in asEntry,
                       const tString &in asBranch,
                       int alId,
                       const tString &in asCallback)

Parameters

• asEntry (tString) —
• asBranch (tString) —
• alId (int) —
• asCallback (tString) —

Returns:

• void

Begin

void Begin(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

CharacterIsActive

bool CharacterIsActive(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• bool—

End

void End(const tString &in asStartBranch)

Parameters

• asStartBranch (tString) —

Returns:

• void

GetCharacterScene

tString GetCharacterScene(const tString &in asCharacterName)

Parameters

• asCharacterName (tString) —

Returns:

• tString—

GetCharactersInSubject

void GetCharactersInSubject(const tString &in asSubject,
                            tString avOutCharacters)

Parameters

• asSubject (tString) —
• avOutCharacters (tString) —

Returns:

• void

GetVar

int GetVar(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• int—

IncVar

void IncVar(const tString &in asName,
            int alX)

Parameters

• asName (tString) —
• alX (int) —

Returns:

• void

ReturnResponseSelectChoice

void ReturnResponseSelectChoice(int alSelectedOption)

Parameters

• alSelectedOption (int) —

Returns:

• void

SetCallbackFunc

void SetCallbackFunc(const tString &in asFunc)

Parameters

• asFunc (tString) —

Returns:

• void

SetResponseTimeLimit

void SetResponseTimeLimit(float afTime)

Parameters

• afTime (float) —

Returns:

• void

SetVar

void SetVar(const tString &in asName,
            int alX)

Parameters

• asName (tString) —
• alX (int) —

Returns:

• void

Stop

void Stop(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

StopAll

void StopAll()

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iScrDialogHandler Interface ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)

See all references...