Class SoundEmitterSprite

Classdesc

SoundEmitterSprite class, used for emitting sounds from a Sprite. This treats the Sprite as a sort of speaker

Example

 const soundEmitter = new ANVIL.SoundEmitterSprite({
     coordinates: [0,0],
     width: 100,
     height: 100,
     url: "path/to/sprite.png",
     soundOptions: {
         source: "path/to/sound.mp3",
         listener: playerObject,
         loop: true,
         volume: 1,
         maxDistance: 1000,
         minDistance: 0,
         fallOffFunction: (distance) => {
             var falloffstart = this.maxDistance - this.minDistance;
             var dist = distance - this.minDistance;
             var vol = 1 - (dist / falloffstart);
             if (vol < 0) vol = 0;
             return vol;
         } 
     }
 });

Hierarchy (view full)

Sprite
- SoundEmitterSprite

Constructors

constructor

new SoundEmitterSprite(options, soundOptions): SoundEmitterSprite
Parameters
- options: SpriteOptions
- soundOptions: SoundEmitterOptions
Returns SoundEmitterSprite
Overrides Sprite.constructor
- Defined in index.ts:4734

Properties

_state

_state: {
[key: string]: any;
}

used for state() and returnState(), builds states that are returnable. Stacking two states is destructive.

Type declaration

[key: string]: any

blockedBy

blockedBy: GameObject[]

List of objects that block this object

blocks

blocks: GameObject[]

List of objects that this object blocks

body

body: any

reference to the physics body (matter.js). Empty if physics is not enabled

bounds

bounds: number[]

how the object is bounded in the scene (set with scene.setBoundaries())

boundsActive

boundsActive: boolean

are the bounds active on this object?

convex

convex: boolean

true if the object is convex, false otherwise

coordinates

coordinates: Vec2

coordinates of the sprite, or the top left most point of the sprite

gameObjectOptions

gameObjectOptions: GameObjectOptions

Game object options of the game object (for serialization and recreation)

height

height: number

height of the sprite

hitbox

hitbox: Vec2

Hitbox of the object, if the object is a square

id

id: string

unique ID for each object

image

image: string

url of the image to use for the sprite

isLocalPlayer

isLocalPlayer: boolean

True if the object is the local player, false otherwise

listener

listener: GameObject

The GameObject that "listens" to the sound. Sound volume will be determined by distance to this game object

physicsEnabled

physicsEnabled: boolean

boolean if physics is enabled on the object

physicsOptions

physicsOptions: PhysicsOptions

options for the physics engine

pinRef

pinRef: "center" | "coordinates"

Reference point to pin the object to (only applies if the object is pinned)

pinned

pinned: null | GameObject

does nothing!

points

points: Vec2[]

points of the object (used for collision detection)

sound

sound: Sound

The Sound instance that the SoundEmitterPolygon plays

source

source: HTMLImageElement

the image element to use for the sprite

spriteLoaded

spriteLoaded: boolean

true if the sprite is loaded, false otherwise

square

square: boolean

True if the object is a square, false otherwise

type

type: string

type of the object, either "gameObject", "sprite", or "polygon"

width

width: number

width of the sprite

Methods

activateBounds

activateBounds(): void
Activates bounds on that object

Returns void
Inherited from Sprite.activateBounds
- Defined in index.ts:1482

applyForce

applyForce(vector): void
Applies a force to the object (only works if physics enabled)
Parameters
- vector: Vec2
  The force vector to apply to the object
Returns void
Inherited from Sprite.applyForce
- Defined in index.ts:1399

changeSource

changeSource(image): void
Changes the sprites image source
Parameters
- image: string
  The new image URL to use for the sprite
Returns void
Inherited from Sprite.changeSource
- Defined in index.ts:1911

checkCollision

checkCollision(object): boolean | Boolean
Checks for a collision with another object
Parameters
- object: GameObject
  The object to check for a collision with
Returns boolean | Boolean
Boolean, true of the object is colliding with the other object, false otherwise
Inherited from Sprite.checkCollision
- Defined in index.ts:1541

checkPolygonalCollision

checkPolygonalCollision(polygon): boolean | Boolean
Checks for a collision with a polygon
Parameters
- polygon: Vec2[]
  The polygon (lower case, not type Polygon) to check for a collision with
Returns boolean | Boolean
Boolean, true of the object is colliding with the other object, false otherwise
Inherited from Sprite.checkPolygonalCollision
- Defined in index.ts:1558

disableBounds

disableBounds(): void
Disables bounds on that object

Returns void
Inherited from Sprite.disableBounds
- Defined in index.ts:1475

draw

draw(options): void
Draws the sprite onto the provided drawing context. This is handled automatically with scene and scene managers
Parameters
- options: DrawOptions
  The DrawOptions for the object
Returns void
Inherited from Sprite.draw
- Defined in index.ts:1864

drawLabel

drawLabel(options): void
Draws the object's label on top of the object The label is the objects meta label (eg: object.meta.label = "...")
Parameters
- options: DrawOptions
  The DrawOptions for the object
Returns void
Inherited from Sprite.drawLabel
- Defined in index.ts:1445

getHeight

getHeight(): number
Returns number
The height of the sprite
Inherited from Sprite.getHeight
- Defined in index.ts:1845

getWidth

getWidth(): number
Returns number
The width of the sprite
Inherited from Sprite.getWidth
- Defined in index.ts:1838

initialize

initialize(scene): void
Parameters
- scene: Scene
Returns void
Inherited from Sprite.initialize
- Defined in index.ts:1587

move

move(vector, continueAfterPhysics?): Boolean
Top level move function (works with both physics enabled and disabled)... needs helper functions getWidth(), getHeight() to be defined. Recommended to re-write based on your use case (if extending)
Parameters
- vector: Vec2
  Vector to move the object by
- continueAfterPhysics: boolean = true
  If set to false, the object will not move if physics are not enabled. If true, the object will move if physics are not enabled. True by defualt
Returns Boolean
Boolean, true if the move was successful, false if it was not (if it was out of bounds, it will not move)
Inherited from Sprite.move
- Defined in index.ts:1507

moveStatic

moveStatic(vector): true | Boolean
Moves an object that has physics enabled by a vector (no forces pr boundaries involved)
Parameters
- vector: Vec2
  The vector to move the object by
Returns true | Boolean
Whether the object was moved or not (if it was out of bounds, it will not move)
Inherited from Sprite.moveStatic
- Defined in index.ts:1492

moveTo

moveTo(point): void
Parameters
- point: Vec2
Returns void
Inherited from Sprite.moveTo
- Defined in index.ts:1589

pin(object, to): void
Modifies pin to a game object
Parameters
- object: GameObject
  The game object to pin to
- to: "center" | "coordinates"
  The reference point to pin to (either "center" or "coordinates")
Returns void
Inherited from Sprite.pin
- Defined in index.ts:1416

playSound

playSound(): void
Plays the sound

Returns void
- Defined in index.ts:4774

polify

polify(): Vec2[]
Calculates the vertices of the sprite

Returns Vec2[]
The vertices of the sprite
Inherited from Sprite.polify
- Defined in index.ts:1920

polifyWithOffset

polifyWithOffset(offset): Vec2[]
Calculates the vertices of the sprite, with an offset applied
Parameters
- offset: Vec2
  The offset to apply to the sprite
Returns Vec2[]
The vertices of the sprite, with the offset applied
Inherited from Sprite.polifyWithOffset
- Defined in index.ts:1934

reload

reload(): void
Loads the sprite, or reloads the image source when the image is changed

Returns void
Inherited from Sprite.reload
- Defined in index.ts:1851

reshape

reshape(width, height): void
Reshapes the sprite according to the provided dimensions
Parameters
- width: number
  The new width of the sprite
- height: number
  The new height of the sprite
Returns void
Inherited from Sprite.reshape
- Defined in index.ts:1890

returnState

returnState(): void
Returns to the old state (before state() was called). Used for clicking

Returns void
Inherited from Sprite.returnState
- Defined in index.ts:1361

scale

scale(factor): void
Scales the sprite by the provided factor. 1 is the default size, 2 is twice the size, 0.5 is half the size, etc.
Parameters
- factor: number
  The factor to scale the sprite by
Returns void
Inherited from Sprite.scale
- Defined in index.ts:1900

serialize

serialize(): GameObjectOptions
Returns the object as a JSON object

Returns GameObjectOptions
The object as a JSON object
Inherited from Sprite.serialize
- Defined in index.ts:1325

setBounds

setBounds(bounds): void
Sets the object's bounds (where it can move)
Parameters
- bounds: number[]
  The bounds to set the object to
Returns void
Inherited from Sprite.setBounds
- Defined in index.ts:1467

state

state(attr, value): void
Changes an attribute of the object (non destructive). To return to the original object, use returnState. Used for clicking
Parameters
- attr: string
  The attribute to change
- value: any
  The new value of that attribute
Returns void
Inherited from Sprite.state
- Defined in index.ts:1350

stopSound

stopSound(): void
Stops the sound

Returns void
- Defined in index.ts:4781

unpin

unpin(): void
Removes the pinned object

Returns void
Inherited from Sprite.unpin
- Defined in index.ts:1407

update

update(): void
Updates the sound based on the listener's position, then calls the update method of the Sprite

Returns void
Overrides Sprite.update
- Defined in index.ts:4756

updatePhysics

updatePhysics(): void
Updates object physics 1 tick

Returns void
Inherited from Sprite.updatePhysics
- Defined in index.ts:1370

`Static` From

From(options): GameObject | Sprite | Polygon
Parameters
- options: GameObjectOptions
Returns GameObject | Sprite | Polygon
Inherited from Sprite.From
- Defined in index.ts:1293

Class SoundEmitterSprite

Classdesc

Example

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: SpriteOptions

soundOptions: SoundEmitterOptions

Returns SoundEmitterSprite

Properties

_state

Type declaration

[key: string]: any

blockedBy

blocks

body

bounds

boundsActive

convex

coordinates

gameObjectOptions

height

hitbox

id

image

isLocalPlayer

listener

meta

physicsEnabled

physicsOptions

pinRef

pinned

points

sound

source

spriteLoaded

square

type

width

Methods

activateBounds

Returns void

applyForce

Parameters

vector: Vec2

Returns void

changeSource

Parameters

image: string

Returns void

checkCollision

Parameters

object: GameObject

Returns boolean | Boolean

checkPolygonalCollision

Parameters

polygon: Vec2[]

Returns boolean | Boolean

disableBounds

Returns void

draw

Parameters

options: DrawOptions

Returns void

drawLabel

Parameters

options: DrawOptions

Returns void

getHeight

Returns number

getWidth

Returns number

initialize

Parameters

scene: Scene

`Static` From