HPL3/Amnesia: Rebirth/Scripting/cLuxBarkMachine

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting
Revision as of 22:22, 15 November 2020 by Abion47 (talk | contribs) (Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== cLuxBarkMachine has no public fields. ==F...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Info icon.png

This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete.

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

Fields

cLuxBarkMachine has no public fields.

Functions

Return Type Function And Description
void AddState(int alId)
void ChangeState(int alId)
iLuxEntity GetEntity()
int GetType()
bool IsActive()
void PlayVoice(const tString &in asSubject, int alPrio, float afMinDistance = -1, float afMaxDistance = -1, float afMaxPlayerListeningRange = -1)
void SetActive(bool abX)
void SetState_SoundBark(const tString &in asSound, float afMinBetweenTime, float afMaxBetweenTime, bool abWaitForSoundToBeDone)
void SetState_VoiceBark(const tString &in asSubject, float afMinBetweenTime, float afMaxBetweenTime, bool abWaitForSoundToBeDone, int alPrio = 0, float afMinDistance = -1, float afMaxDistance = -1, float afMaxPlayerListeningRange = -1)
void SetupVoice(const tString &in asCharacter, bool abUse3D, float afDefaultMinDistance, float afDefaultMaxDistance, float afDefaultMaxPlayerListeningRange)

Details

AddState

void AddState(int alId)


Parameters

  • alId (int) —

Returns:

  • void

ChangeState

void ChangeState(int alId)


Parameters

  • alId (int) —

Returns:

  • void

GetEntity

iLuxEntity@ GetEntity()

Returns:

  • iLuxEntity@—

GetType

int GetType()

Returns:

  • int—

IsActive

bool IsActive()

Returns:

  • bool—

PlayVoice

void PlayVoice(const tString &in asSubject,
               int alPrio,
               float afMinDistance = -1,
               float afMaxDistance = -1,
               float afMaxPlayerListeningRange = -1)


Parameters

  • asSubject (tString) —
  • alPrio (int) —
  • afMinDistance (float) —
  • afMaxDistance (float) —
  • afMaxPlayerListeningRange (float) —

Returns:

  • void

SetActive

void SetActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetState_SoundBark

void SetState_SoundBark(const tString &in asSound,
                        float afMinBetweenTime,
                        float afMaxBetweenTime,
                        bool abWaitForSoundToBeDone)


Parameters

  • asSound (tString) —
  • afMinBetweenTime (float) —
  • afMaxBetweenTime (float) —
  • abWaitForSoundToBeDone (bool) —

Returns:

  • void

SetState_VoiceBark

void SetState_VoiceBark(const tString &in asSubject,
                        float afMinBetweenTime,
                        float afMaxBetweenTime,
                        bool abWaitForSoundToBeDone,
                        int alPrio = 0,
                        float afMinDistance = -1,
                        float afMaxDistance = -1,
                        float afMaxPlayerListeningRange = -1)


Parameters

  • asSubject (tString) —
  • afMinBetweenTime (float) —
  • afMaxBetweenTime (float) —
  • abWaitForSoundToBeDone (bool) —
  • alPrio (int) —
  • afMinDistance (float) —
  • afMaxDistance (float) —
  • afMaxPlayerListeningRange (float) —

Returns:

  • void

SetupVoice

void SetupVoice(const tString &in asCharacter,
                bool abUse3D,
                float afDefaultMinDistance,
                float afDefaultMaxDistance,
                float afDefaultMaxPlayerListeningRange)


Parameters

  • asCharacter (tString) —
  • abUse3D (bool) —
  • afDefaultMinDistance (float) —
  • afDefaultMaxDistance (float) —
  • afDefaultMaxPlayerListeningRange (float) —

Returns:

  • void

References

See all references...

Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/cLuxBarkMachine&oldid=5748"