Game Framework
GameFramework.Audio.Messages.BackgroundVolumeChangedMessage Class Reference

A message that is generated when the background volume changes. More...

Inheritance diagram for GameFramework.Audio.Messages.BackgroundVolumeChangedMessage:
GameFramework.Messaging.BaseMessage

Public Member Functions

 BackgroundVolumeChangedMessage (float oldVolume, float newVolume)
 
override string ToString ()
 Return a representation of the message More...
 
- Public Member Functions inherited from GameFramework.Messaging.BaseMessage
 BaseMessage ()
 
void DontShowInEditorLog ()
 Hide this message so that it isn't displayed in the editor logs. (Editor only method) More...
 

Public Attributes

readonly float OldVolume
 The old Volume More...
 
readonly float NewVolume
 The new Volume More...
 
- Public Attributes inherited from GameFramework.Messaging.BaseMessage
string Name
 
SendModeType SendMode
 
bool DontShowInEditorLogInternal
 

Additional Inherited Members

- Public Types inherited from GameFramework.Messaging.BaseMessage
enum  SendModeType { SendModeType.SendToAll, SendModeType.SendToFirst }
 

Detailed Description

A message that is generated when the background volume changes.

Constructor & Destructor Documentation

GameFramework.Audio.Messages.BackgroundVolumeChangedMessage.BackgroundVolumeChangedMessage ( float  oldVolume,
float  newVolume 
)

Member Function Documentation

override string GameFramework.Audio.Messages.BackgroundVolumeChangedMessage.ToString ( )

Return a representation of the message

Returns

Member Data Documentation

readonly float GameFramework.Audio.Messages.BackgroundVolumeChangedMessage.NewVolume

The new Volume

readonly float GameFramework.Audio.Messages.BackgroundVolumeChangedMessage.OldVolume

The old Volume


The documentation for this class was generated from the following file: