The WwiseEvent Script

The Papyrus Index is still under construction. Structs have not been implemented yet.

No properties found.

No events found.

• Found in:
  • Vanilla

  WwiseEvent:WwiseSwitchParamfunctionMakeNewWwiseSwitchParam(stringaGroupName, stringaStateName)Global

  Helper function to construct a WwiseSwitchParam

• Found in:
  • Vanilla

  WwiseEvent:WwiseRTPCParamfunctionMakeNewWwiseRTPCParam(stringaName, floataValue)Global

  Helper function to construct a WwiseRTPCParam

• Found in:
  • Vanilla

  intfunctionPlay(ObjectReferenceakSource, WwiseEvent:WwiseSwitchParam[]aSwitchParams=NONE, WwiseEvent:WwiseRTPCParam[]aRTPCParams=NONE)

  Play this sound base object from the specified source

• Found in:
  • Vanilla

  intfunctionPlayUI(WwiseEvent:WwiseSwitchParam[]aSwitchParams=NONE, WwiseEvent:WwiseRTPCParam[]aRTPCParams=NONE)

  Play this sound base object as a UI sound

• Found in:
  • Vanilla

  boolfunctionPlayAndWait(ObjectReferenceakSource, WwiseEvent:WwiseSwitchParam[]aSwitchParams=NONE, WwiseEvent:WwiseRTPCParam[]aRTPCParams=NONE)

  Play this sound base object from the specified source, and wait for it to finish

• Found in:
  • Vanilla

  boolfunctionPlayUIAndWait(WwiseEvent:WwiseSwitchParam[]aSwitchParams=NONE, WwiseEvent:WwiseRTPCParam[]aRTPCParams=NONE)

  Play this sound base object as a UI sound, and wait for it to finish

• Found in:
  • Vanilla

  intfunctionPlayWithRTPC(ObjectReferenceakSource, stringasRTPCName, floatafRTPCValue)Native

  Play this sound base object from the specified source and set an RTPC on the instance before playing

• Found in:
  • Vanilla

  intfunctionPlayUIWithRTPC(stringasRTPCName, floatafRTPCValue)Native

  Play this sound base object as UI and set an RTPC on the instance before playing

• Found in:
  • Vanilla

  voidfunctionStopInstance(intaiPlaybackInstance)NativeGlobal

  Stops a given playback instance of a sound

• Found in:
  • Vanilla

  voidfunctionUpdateInstanceRTPC(intaiPlaybackInstance, stringasRTPCName, floatafRTPCValue)NativeGlobal

  Update a single RTPC value on a given playback instance of a sound

• Found in:
  • Vanilla

  voidfunctionUpdateInstanceRTPCs(intaiPlaybackInstance, WwiseEvent:WwiseRTPCParam[]aRTPCParams)Global

  Update a set of RTPC values on a given playback instance of a sound

• Found in:
  • Vanilla

  voidfunctionSetGlobalRTPC(stringasRTPCName, floatafRTPCValue)NativeGlobal

  Sets the global value of a Wwise real-time parameter control

• Found in:
  • Vanilla

  voidfunctionSetGlobalState(stringasStateGroup, stringasStateName)NativeGlobal

  Sets a global Wwise State Group to the given named state

• Found in:
  • Vanilla

  voidfunctionPlayMenuSound(stringasSoundID)NativeGlobal

  Called by the VM to play a UI sound by the ID of sound

• Found in:
  • Vanilla

  string[]functionExtractSwitchGroups(WwiseEvent:WwiseSwitchParam[]aSwitchParams)Global

  For internal use only. Extracts an array of Switch Group names from an array of WwiseSwitchParam.

• Found in:
  • Vanilla

  string[]functionExtractSwitchStates(WwiseEvent:WwiseSwitchParam[]aSwitchParams)Global

  For internal use only. Extracts an array of Switch State names from an array of WwiseSwitchParam.

• Found in:
  • Vanilla

  string[]functionExtractRTPCNames(WwiseEvent:WwiseRTPCParam[]aRTPCParams)Global

  For internal use only. Extracts an array of RTPC names from an array of WwiseRTPCParam.

• Found in:
  • Vanilla

  float[]functionExtractRTPCValues(WwiseEvent:WwiseRTPCParam[]aRTPCParams)Global

  For internal use only. Extracts an array of RTPC values from an array of WwiseRTPCParam.

• Found in:
  • Vanilla

  intfunctionPlayImpl(ObjectReferenceakSource, string[]aSwitchGroups, string[]aSwitchStates, string[]aRTPCNames, float[]aRTPCValues)Native

  For internal use only. Users should call the Play function defined above. Play this Wwise Event from the given ObjectReference with an optional set of control parameters.

• Found in:
  • Vanilla

  voidfunctionPlayUIImpl(string[]aSwitchGroups, string[]aSwitchStates, string[]aRTPCNames, float[]aRTPCValues)Native
• Found in:
  • Vanilla

  voidfunctionPlayAndWaitImpl(ObjectReferenceakSource, string[]aSwitchGroups, string[]aSwitchStates, string[]aRTPCNames, float[]aRTPCValues)Native
• Found in:
  • Vanilla

  voidfunctionPlayUIAndWaitImpl(string[]aSwitchGroups, string[]aSwitchStates, string[]aRTPCNames, float[]aRTPCValues)Native
• Found in:
  • Vanilla

  <UNKNOWN_SCRIPT: private>functionUpdateInstanceRTPCsImpl(intaiPlaybackInstance, string[]aRTPCNames, float[]aRTPCValues)NativeGlobal