Zum Hauptinhalt springen

Audio

Beschreibung​

Mit dieser Komponente können Entitäten Klänge abspielen.

Eigenschaften​

EigenschaftTypStandardBeschreibung
url (erforderlich)String''Quelle URL
BandNummer1Wie laut der Ton abgespielt werden soll. Ein Wert zwischen 0 und 1
SchleifebooleanfalseOb der Ton nach Beendigung neu gestartet wird
pausiertbooleanfalseOb der Ton gerade pausiert ist
StellplatzNummer1Der Faktor, der verwendet wird, um die Tonhöhe des Audios zu ändern. 1 ist die Standardeinstellung.
StandortbooleanfalseOb das Audio positionell abgespielt wird
refDistanceNummer1Wird nur angewandt, wenn positional true ist. Der Wert, der angibt, ab welcher Entfernung die Lautstärke von dieser Quelle abnimmt, wenn sich der Zuhörer entfernt. Muss ein nicht-negativer Wert sein.
distanceModelStringInvers**Der Algorithmus, der verwendet wird, um die Lautstärke mit zunehmender Entfernung zwischen dieser Audioquelle und dem Zuhörer zu reduzieren. Mögliche Werte sind "linear", "invers" und "exponentiell".
rolloffFactorNummer1Wird nur angewendet, wenn positional true ist. Wie schnell die Lautstärke mit zunehmender Entfernung zwischen dieser Audioquelle und dem Zuhörer reduziert wird. Der zulässige Wertebereich ändert sich je nach distanceModel wie folgt: linear: 0 bis 1, invers: 0 bis Unendlich, exponentiell: 0 bis Unendlich
maxDistanceNummer10000Wird nur angewandt, wenn positional wahr ist und distanceModel gleich linear ist. Der maximale Abstand zwischen dieser Audioquelle und dem Zuhörer. Danach wird das Volumen nicht mehr reduziert. Muss ein positiver Wert sein.

Funktionen​

Get​

Returns a read-only reference.

Example

ecs.Audio.get(world, component.eid)

Set​

Ensures the component exists on the entity, then assigns the (optional) data to the component.

Example

ecs.Audio.set(world, component.eid, {
  url: '',
  volume: 1,
  loop: false,
  paused: false,
  pitch: 1,
  positional: false,
  refDistance: 1,
  distanceModel: ''inverse'',
  rolloffFactor: 1,
  maxDistance: 10000
})

Mutate​

Perform an update to the component within a callback function. Return true to indicate no changes made.

Example

ecs.Audio.mutate(world, component.eid, (cursor) => {
  cursor.volume = 0.5;
  cursor.loop = true;
  return false;
})

Remove​

Removes the component from the entity.

Example

ecs.Audio.remove(world, component.eid)

Has​

Returns true if the component is present on the entity.

Example

ecs.Audio.has(world, component.eid)

Reset​

Adds, or resets the component to its default state.

Example

ecs.Audio.reset(world, component.eid)

Advanced Functions​

Cursor​

Returns a mutable reference. Cursors are reused so only one cursor for each component can exist at a time.

Example
ecs.Audio.cursor(world, component.eid)

Acquire​

Same behavior as cursor, but commit must be called after the cursor is done being used.

Example
ecs.Audio.acquire(world, component.eid)

Commit​

Called after acquire. An optional third argument determines whether the cursor was mutated or not.

Example
ecs.Audio.commit(world, component.eid)
ecs.Audio.commit(world, component.eid, false)

Dirty​

Mark the entity as having been mutated. Only needed in a specific case where systems are mutating data.

Example
ecs.Audio.dirty(world, component.eid)