Passer au contenu principal

Audio

Description​

Ce composant permet aux entités de jouer des sons.

Propriétés​

PropriétéTypeDéfautDescription
url (Obligatoire)chaîne de caractères''Source URL
volumenombre1Volume de l'audio qui sera joué. Une valeur comprise entre 0 et 1
bouclebooléenfauxSi l'audio redémarre après avoir terminé
en pausebooléenfauxSi l'audio est actuellement en pause
hauteurnombre1Facteur utilisé pour modifier la hauteur du son. 1 est la hauteur par défaut.
positionnelbooléenfauxSi l'audio est joué de manière positionnelle
refDistancenombre1**La valeur indiquant la distance à laquelle le volume de cette source commencera à diminuer lorsque l'auditeur s'éloignera. Doit être une valeur non négative.
modèle de distancechaîne de caractèresinverse**L'algorithme utilisé pour réduire le volume à mesure que la distance entre cette source audio et l'auditeur augmente. Les valeurs possibles sont "linéaire", "inverse" et "exponentiel".
Facteur d'atténuationnombre1**La vitesse à laquelle le volume est réduit lorsque la distance entre cette source audio et l'auditeur augmente. La plage de valeurs acceptables change en fonction du modèle de distance, comme le montrent les exemples suivants : linéaire : 0 à 1, inverse : 0 à l'infini, exponentiel : 0 à l'infini
maxDistancenombre10000Appliqué uniquement si positional est vrai et si distanceModel est égal à linear. La distance maximale entre cette source audio et l'auditeur. Le volume n'est pas réduit après ce point. Doit être une valeur positive.

Fonctions​

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)