Castle Game Engine

Introduction

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Unit CastleSoundEngine

DescriptionUsesClasses, Interfaces, Objects and RecordsFunctions and ProceduresTypesConstantsVariables

Description

3D sound engine (TSoundEngine and TRepoSoundEngine).

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class ESoundBufferNotLoaded  
Class TSoundBuffersCache  
Class TSoundDevice  
Class TSoundParameters Parameters to use when playing sound, see TSoundEngine.PlaySound.
Class TSoundEngine OpenAL sound engine.
Class TSoundInfo Sound information, internally used by TRepoSoundEngine.
Object TSoundType Unique sound type identifier for sounds used within TRepoSoundEngine.
Class TRepoSoundEngine Sound engine that keeps a repository of sounds, defined in a nice XML file.
Class TMusicPlayer Music player, to easily play a sound preloaded by TRepoSoundEngine.

Functions and Procedures

function SoundEngine: TRepoSoundEngine;
operator = (const SoundType1, SoundType2: TSoundType): boolean;

Types

TSoundBuffer = CastleSoundAllocator.TSoundBuffer;
TSound = CastleSoundAllocator.TSound;
TSoundList = CastleSoundAllocator.TSoundList;
TSoundDistanceModel = (...);
TSoundBuffersCacheList = specialize TFPGObjectList<TSoundBuffersCache>;
TSoundDeviceList = specialize TFPGObjectList<TSoundDevice>;
TSoundInfoList = specialize TFPGObjectList<TSoundInfo>;

Constants

stNone: TSoundType = (Index: 0);
MaxSoundImportance = MaxInt;
LevelEventSoundImportance = 100000;
PlayerSoundImportance = 10000;
DefaultCreatureSoundImportance = 1000;
MinorNonSpatialSoundImportance = 100;

Variables

stPlayerInteractFailed:TSoundType;
stPlayerPickItem:TSoundType;
stPlayerDropItem:TSoundType;
stPlayerSwimming:TSoundType;
stPlayerDrowning:TSoundType;
stPlayerFootstepsDefault:TSoundType;
stPlayerToxicPain:TSoundType;
stPlayerSuddenPain:TSoundType;
stPlayerDies:TSoundType;
stPlayerSwimmingChange:TSoundType;
stMenuCurrentItemChanged:TSoundType;
stMenuClick:TSoundType;

Description

Functions and Procedures

function SoundEngine: TRepoSoundEngine;

The sound engine. Singleton instance of TRepoSoundEngine, the most capable engine class. Created on first call to this function.

operator = (const SoundType1, SoundType2: TSoundType): boolean;
 

Types

TSoundBuffer = CastleSoundAllocator.TSoundBuffer;
 
TSound = CastleSoundAllocator.TSound;
 
TSoundList = CastleSoundAllocator.TSoundList;
 
TSoundDistanceModel = (...);
 
Values
  • dmNone:  
  • dmInverseDistance:  
  • dmInverseDistanceClamped:  
  • dmLinearDistance:  
  • dmLinearDistanceClamped:  
  • dmExponentDistance:  
  • dmExponentDistanceClamped:  
TSoundBuffersCacheList = specialize TFPGObjectList<TSoundBuffersCache>;
 
TSoundDeviceList = specialize TFPGObjectList<TSoundDevice>;
 
TSoundInfoList = specialize TFPGObjectList<TSoundInfo>;
 

Constants

stNone: TSoundType = (Index: 0);

Special sound type that indicates that there is actually no sound. TRepoSoundEngine.Sound and TRepoSoundEngine.Sound3D will do nothing when called with this sound type.

MaxSoundImportance = MaxInt;
 
LevelEventSoundImportance = 100000;
 
PlayerSoundImportance = 10000;
 
DefaultCreatureSoundImportance = 1000;
 
MinorNonSpatialSoundImportance = 100;
 

Variables

stPlayerInteractFailed:TSoundType;

Player sounds.

stPlayerPickItem:TSoundType;

Player sounds.

stPlayerDropItem:TSoundType;

Player sounds.

stPlayerSwimming:TSoundType;

Player sounds.

stPlayerDrowning:TSoundType;

Player sounds.

stPlayerFootstepsDefault:TSoundType;

Player sounds.

stPlayerToxicPain:TSoundType;

Player sounds.

stPlayerSuddenPain:TSoundType;

Player sounds.

stPlayerDies:TSoundType;

Player sounds.

stPlayerSwimmingChange:TSoundType;

Player sounds.

stMenuCurrentItemChanged:TSoundType;

Sounds used by TCastleOnScreenMenu.

stMenuClick:TSoundType;

Sounds used by TCastleOnScreenMenu.

Generated by PasDoc 0.14.0.