VoipEmitter
Summary
Properties
| Name | Type |
|---|---|
| player | Player |
| channel | VoipChannel |
| isEmitting | bool |
| emitterType | VoipEmitterType |
| volume | float |
| position | Vec3 |
| boundToBone | int | nil |
| leftBalance | float |
| rightBalance | float |
| maxDistance | float |
| muted | bool |
Properties
player
The player this emitter is bound to.
channel
The VoIP channel this emitter belongs to.
isEmitting
bool
Will be true if this emitter is currently emitting sound.
emitterType
The type of the emitter. Will default to the channel's defaultEmitterType but can be overriden on the fly.
volume
float
The volume of the emitter, from 0.0 to 1.0. Defaults to 1.0.
position
The position of the emitter in 3D space. This is only relevant for Positional emitters.
boundToBone
int | nil
The SoldierEntity bone to bind this emitter to, or nil if it should not be bound to anything. When this is set to a valid value, the engine will automatically update the position of the emitter to match the position of the specified bone.
leftBalance
float
The audio balance / volume for the left channel, from 0.0 to 1.0. This defaults to 1.0 and only has effect on Local emitters.
rightBalance
float
The audio balance / volume for the right channel, from 0.0 to 1.0. This defaults to 1.0 and only has effect on Local emitters.
maxDistance
float
The maximum distance (in in-game units) that audio will be audible from for Positional emitters. The audio will be linearly faded based on the emitter's distance to the current player.
muted
bool
Whether this emitter should be muted or not. When set to true, the emitter will stop producing sound.