Vixen
02b45cc4
csharp
public enum AudioBuiltinParameter

Something the engine already knows, offered as a parameter.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

The point is that gameplay does not set these. The spatialiser works all four out every block anyway; a parameter marked with one of them has its value written by the engine each frame, so a designer can draw a curve against distance without a programmer plumbing distance anywhere. Setting one by hand is refused rather than ignored.

They are ordinary parameters otherwise — the range, the curves and the seek time all mean what they always did, and a sheet may mix built-in and gameplay-driven ones freely.

Fields and properties (6)

  • None

    Not one. The value is whatever gameplay last set.

  • Distance

    How far the sound is from the listener, in world units.

  • Direction

    Which way round the listener it is, in degrees: 0 ahead, +90 right, ±180 behind.

  • Elevation

    How far above or below the listener it is, in degrees: +90 overhead, −90 underfoot.

  • Speed

    How fast the source is moving, in units a second.

  • Occlusion

    How much solid geometry is in the way: 0 for a clear path, 1 for a blocked one.

Used by (8)

  • AudioParameterAssetVixen.Audio
  • AudioParameterDefinitionVixen.Audio
  • AudioParameterSheetVixen.Audio
  • BuiltinParameterTestsVixen.Audio.Tests
  • OcclusionTestsVixen.Audio.Tests
  • TypeRegistrationVixen.Audio
  • Vixen_Audio_Assets_AudioParameterAssetSerializerVixen.Audio
  • VoiceParametersVixen.Audio