com.threerings.openal.config
Class SounderConfig.Clip

java.lang.Object
  com.threerings.util.DeepObject
      com.threerings.openal.config.SounderConfig.Implementation
          com.threerings.openal.config.SounderConfig.Original
              com.threerings.openal.config.SounderConfig.Fixed
                  com.threerings.openal.config.SounderConfig.BaseClip
                      com.threerings.openal.config.SounderConfig.Clip

All Implemented Interfaces:

Exportable, Copyable, Cloneable

Enclosing class:

SounderConfig

public static class SounderConfig.Clip
extends SounderConfig.BaseClip

Plays a sound clip.

Field Summary

String

file The sound resource from which to load the clip.

Fields inherited from class com.threerings.openal.config.SounderConfig.BaseClip

loop

Fields inherited from class com.threerings.openal.config.SounderConfig.Fixed

gain, pitch

Fields inherited from class com.threerings.openal.config.SounderConfig.Original

coneInnerAngle, coneOuterAngle, coneOuterGain, directional, maxDistance, maxGain, minGain, referenceDistance, rolloffFactor, sourceRelative

Constructor Summary

SounderConfig.Clip()

Method Summary

Sounder.Implementation	getSounderImplementation(AlContext ctx, Scope scope, Sounder.Implementation impl) Creates or updates a sounder implementation for this configuration.
void	getUpdateResources(HashSet<String> paths) Adds the implementation's update resources to the provided set.

Methods inherited from class com.threerings.openal.config.SounderConfig.Fixed

getGain, getPitch

Methods inherited from class com.threerings.openal.config.SounderConfig.Implementation

getUpdateReferences, invalidate

Methods inherited from class com.threerings.util.DeepObject

clone, copy, copy, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

file

@Editable(editor="resource",
          nullable=true,
          weight=-3.0,
          hgroup="f")
@FileConstraints(description="m.sound_files_desc",
                 extensions=".ogg",
                 directory="sound_dir")
public String file

The sound resource from which to load the clip.

Constructor Detail

SounderConfig.Clip

public SounderConfig.Clip()

Method Detail

getUpdateResources

public void getUpdateResources(HashSet<String> paths)

Description copied from class: SounderConfig.Implementation

Adds the implementation's update resources to the provided set.

Overrides:

getUpdateResources in class SounderConfig.Implementation

getSounderImplementation

public Sounder.Implementation getSounderImplementation(AlContext ctx,
                                                       Scope scope,
                                                       Sounder.Implementation impl)

Description copied from class: SounderConfig.Implementation

Creates or updates a sounder implementation for this configuration.

Specified by:

getSounderImplementation in class SounderConfig.Implementation

scope - the sounder's expression scope.

impl - an existing implementation to reuse, if possible.

Returns:

either a reference to the existing implementation (if reused), a new implementation, or null if no implementation could be created.