UE3:UTVehicleMessage (UT3): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
Auto-generated page
 
m updated defaults
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
| parent3 = Object
| parent3 = Object
}}
}}
{{autogenerated}}
Special vehicle-related messages, such as hijack announcements and blocked vehicle spawn notifications.
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.


==Properties==
==Properties==
Line 12: Line 11:
'''Type:''' [[array]]<[[int]]>
'''Type:''' [[array]]<[[int]]>


<!-- enter variable description -->
Unused.


====DrawColors====
====DrawColors====
'''Type:''' [[array]]<{{tl|Color|Object|structs}}>
'''Type:''' [[array]]<{{tl|Color|Object|structs}}>


<!-- enter variable description -->
HUD colors for the various messages.


'''Default value, index 0:'''  
'''Default value, index 0:'''  
Line 130: Line 129:
'''Type:''' [[array]]<{{cl|SoundNodeWave}}>
'''Type:''' [[array]]<{{cl|SoundNodeWave}}>


<!-- enter variable description -->
Announcement sounds for the various messages.


'''Default value, index 4:''' {{cl|SoundNodeWave}}'A_Announcer_Reward.Rewards.A_RewardAnnouncer_Hijacked'
'''Default value, index 4:''' {{cl|SoundNodeWave}}'A_Announcer_Reward.Rewards.A_RewardAnnouncer_Hijacked'
Line 141: Line 140:
'''[[Variables#Modifiers|Modifiers]]:''' localized
'''[[Variables#Modifiers|Modifiers]]:''' localized


<!-- enter variable description -->
The message strings.


'''Default value, index 0:''' "Der Viper Selbstzerstörung wurde noch nicht besetzt."
'''Default value, index 0:''' "Viper self destruct system not yet engaged."


'''Default value, index 1:''' "Fahrzeug ist abgeschlossen!"
'''Default value, index 1:''' "Vehicle is Locked."


'''Default value, index 2:''' "Sie sind der Entstehung eines Fahrzeugs im Wege."
'''Default value, index 2:''' "You are in the way of a vehicle spawning."


'''Default value, index 3:''' "Leviathan ist online."
'''Default value, index 3:''' "Leviathan is online."


'''Default value, index 4:''' "Entführt!"
'''Default value, index 4:''' "Hijacked!"


'''Default value, index 5:''' "Autoentführung!"
'''Default value, index 5:''' "Carjacked!"


===Default values===
===Default values===
Line 162: Line 161:
| {{tl|AnnouncementPriority||UTLocalMessage}}
| {{tl|AnnouncementPriority||UTLocalMessage}}
| 5
| 5
|-
| {{tl|bIsConsoleMessage||LocalMessage}}
| False
|-
|-
| {{tl|bIsPartiallyUnique||LocalMessage}}
| {{tl|bIsPartiallyUnique||LocalMessage}}
Line 182: Line 178:
'''Overrides:''' {{tl|AnnouncementLevel|UTLocalMessage}}
'''Overrides:''' {{tl|AnnouncementLevel|UTLocalMessage}}


<!-- enter function description -->
Returns announcer level 2 for all messages.


====AnnouncementSound====
====AnnouncementSound====
Line 189: Line 185:
'''Overrides:''' {{tl|AnnouncementSound|UTLocalMessage}}
'''Overrides:''' {{tl|AnnouncementSound|UTLocalMessage}}


<!-- enter function description -->
Returns the announcement sound for the specified message.


====ClientReceive====
====ClientReceive====
Line 196: Line 192:
'''Overrides:''' {{tl|ClientReceive|LocalMessage}}
'''Overrides:''' {{tl|ClientReceive|LocalMessage}}


<!-- enter function description -->
Plays the received message's corresponding announcement, if the message has an announcement sound.


====GetColor====
====GetColor====
Line 203: Line 199:
'''Overrides:''' {{tl|GetColor|LocalMessage}}
'''Overrides:''' {{tl|GetColor|LocalMessage}}


<!-- enter function description -->
Returns the specified message's corresponding HUD color.


====GetString====
====GetString====
Line 210: Line 206:
'''Overrides:''' {{tl|GetString|LocalMessage}}
'''Overrides:''' {{tl|GetString|LocalMessage}}


<!-- enter function description -->
Returns the specified message's corresponding message text.

Latest revision as of 08:14, 16 August 2009

UT3 Object >> LocalMessage >> UTLocalMessage >> UTVehicleMessage
Package:
UTGame
This class in other games:

Special vehicle-related messages, such as hijack announcements and blocked vehicle spawn notifications.

Properties

CustomMessageArea

Type: array<int>

Unused.

DrawColors

Type: array<Object.Color>

HUD colors for the various messages.

Default value, index 0:

Member Value
A 255
B 128
G 255
R 255

Default value, index 1:

Member Value
A 255
B 255
G 160
R 0

Default value, index 2:

Member Value
A 255
B 0
G 0
R 255

Default value, index 3:

Member Value
A 255
B 0
G 0
R 255

Default value, index 4:

Member Value
A 255
B 255
G 255
R 255

Default value, index 5:

Member Value
A 255
B 255
G 255
R 255

MessageAnnouncements

Type: array<SoundNodeWave>

Announcement sounds for the various messages.

Default value, index 4: SoundNodeWave'A_Announcer_Reward.Rewards.A_RewardAnnouncer_Hijacked'

Default value, index 5: SoundNodeWave'A_Announcer_Reward.Rewards.A_RewardAnnouncer_CarJacked'

MessageText

Type: array<string>

Modifiers: localized

The message strings.

Default value, index 0: "Viper self destruct system not yet engaged."

Default value, index 1: "Vehicle is Locked."

Default value, index 2: "You are in the way of a vehicle spawning."

Default value, index 3: "Leviathan is online."

Default value, index 4: "Hijacked!"

Default value, index 5: "Carjacked!"

Default values

Static functions

AnnouncementLevel

static function byte AnnouncementLevel (byte MessageIndex)

Overrides: UTLocalMessage.AnnouncementLevel

Returns announcer level 2 for all messages.

AnnouncementSound

static function SoundNodeWave AnnouncementSound (int MessageIndex, Object OptionalObject, PlayerController PC)

Overrides: UTLocalMessage.AnnouncementSound

Returns the announcement sound for the specified message.

ClientReceive

static simulated function ClientReceive (PlayerController P, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)

Overrides: LocalMessage.ClientReceive

Plays the received message's corresponding announcement, if the message has an announcement sound.

GetColor

static function Object.Color GetColor (optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)

Overrides: LocalMessage.GetColor

Returns the specified message's corresponding HUD color.

GetString

static function string GetString (optional int Switch, optional bool bPRI1HUD, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)

Overrides: LocalMessage.GetString

Returns the specified message's corresponding message text.