Class TCastlePlayingSoundSource
Unit
Declaration
type TCastlePlayingSoundSource = class(TCastlePlayingSound)
Description
Controls a sound playback initiated by TCastleSoundSource.Play. See the ancestor TCastlePlayingSound for most important documentation. This class simply extends the ancestor with some properties useful only together with the TCastleSoundSource.
Source: src/transform/castlebehaviors_soundsource.inc (line 26).
Hierarchy
- TObject
- TPersistent
- TComponent
- TCastlePlayingSound
- TCastlePlayingSoundSource
Overview
Methods
 |
procedure DoStop; override; |
 |
constructor Create(AOwner: TComponent); override; |
|
function InternalFinalVolume: Single; override; |
|
function InternalFinalPitch: Single; override; |
|
function InternalFinalPriority: Single; override; |
Properties
|
property Follow: Boolean read FFollow write FFollow default true; |
|
property SoundHeight: Single read FSoundHeight write FSoundHeight
default 0.0; |
Description
Methods
|
procedure DoStop; override; |
|
This item has no description. Showing description inherited from TCastlePlayingSound.DoStop. Do the necessary job after source stopped, due to any reason. In this class it handles OnStop and FreeOnStop. If you override this: Since FreeOnStop may free the instance, you should add your code before calling inherited. Source: src/transform/castlebehaviors_soundsource.inc (line 36). | |
|
constructor Create(AOwner: TComponent); override; |
|
This item has no description. Source: src/transform/castlebehaviors_soundsource.inc (line 38). | |
|
function InternalFinalVolume: Single; override; |
|
This item has no description. Source: src/transform/castlebehaviors_soundsource.inc (line 39). | |
|
function InternalFinalPitch: Single; override; |
|
This item has no description. Source: src/transform/castlebehaviors_soundsource.inc (line 40). | |
|
function InternalFinalPriority: Single; override; |
|
This item has no description. Source: src/transform/castlebehaviors_soundsource.inc (line 41). | |
Properties
|
property Follow: Boolean read FFollow write FFollow default true; |
|
If If not This matters only for spatial sounds (TCastleSoundSource.Spatial). Source: src/transform/castlebehaviors_soundsource.inc (line 57). | |
|
property SoundHeight: Single read FSoundHeight write FSoundHeight
default 0.0; |
|
The exact sound position reflects the transformation of the TCastleSoundSource, either Parent.Translation or Parent.Middle. Use this property to control which one, it makes a linear interpolation between them.
You can conigure Parent.Middle using Parent.MiddleHeight. Source: src/transform/castlebehaviors_soundsource.inc (line 73). | |
Generated by PasDoc 0.17.0.snapshot.