Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation
previous class next class | frames no frames

# Gameplay.SpeechChannel

00001 00002 00003 00004 00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00049
00050
00051
00052
00053
00054
00055
00056
00057
00058

    class SpeechChannel extends Core.Object
    	native;

    enum ESubtitleType
    {
    	SUBTITLE_None,
    	SUBTITLE_Cutscene,
    	SUBTITLE_Announcer
    };

    var int						id;				///< ID of the channel
    var config int				maxSounds;		///< Maximum number of sounds for this channel
    var config int				priority;		///< priority of this channel
    var config bool				bStreamed;		///< streamed files
    var config bool				bLifo;			///< Last sound requested will always be played immediately
    var Array<SpeakerRecord>	speechList;		///< list of currently playing sounds in the channel
    var ConcreteSpeechManager	speechManager;	///< Speech manager which this Channel belongs to
    var float					SpeechVolume;	///< Volume settings for this channel

    var bool					bDebugLogged;	///< whether the channel logs debug messages
    var bool					bDisabled;		///< whether the channel is disabled

    CPPTEXT
    {
    	///
    	/// Plays speech in the channel
    	///
    	FLOAT PlaySpeech(FSpeakerRef speaker, FString speechName, FString packageName, FString basePath = TEXT(""), ESubtitleType subtitleType = SUBTITLE_None, USpeechCategory* category = NULL, UBOOL bPositional = true);

    	///
    	/// Finds a speaker record, if it exists, within the list of currently active
    	/// speech objects. Returns the located record or NULL if one is not found
    	///
    	USpeakerRecord* FindSpeakerRecord(FSpeakerRef speaker);

    	///
    	/// Cancels a currently playing speaker record.
    	///
    	void CancelSpeech(USpeakerRecord *record, UBOOL killSound = 1);

    	///
    	/// Cancels all currently playing speech in the channel.
    	///
    	void CancelAllSpeech();

    	///
    	/// Updates the channel
    	///
    	void Tick(FLOAT dt);
    }

    defaultproperties
    {
    	SpeechVolume=1.0
    	maxSounds=5
    	bStreamed=true
    	bLifo=false
    }

Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation
previous class next class | frames no frames

Class file time: ne 5.9.2004 15:53:26.000 - Creation time: st 23.5.2018 00:10:47.246 - Created with UnCodeX