Difference between revisions of "Text"

From GTAMods Wiki
Jump to navigation Jump to search
m
(message queue)
 
Line 14: Line 14:
 
</div></div>
 
</div></div>
 
A message is text positioned on the bottom of the screen. The default text color of the message is white, which uses the [[GXT#Tokens|token]] <code>~h~</code> in the GXT file. For Vice City and San Andreas, enabling [[02A3|widescreen]] repositions the message so that it appears centered and inside the black bars. This type of text is used extensively during [[cutscene]]s where messages can be hidden if the subtitles option is switched off. In the "Brief" section of the pause menu, the last few uniquely printed messages are added and can be viewed. If the message already appears there, it will not be readded to the section.
 
A message is text positioned on the bottom of the screen. The default text color of the message is white, which uses the [[GXT#Tokens|token]] <code>~h~</code> in the GXT file. For Vice City and San Andreas, enabling [[02A3|widescreen]] repositions the message so that it appears centered and inside the black bars. This type of text is used extensively during [[cutscene]]s where messages can be hidden if the subtitles option is switched off. In the "Brief" section of the pause menu, the last few uniquely printed messages are added and can be viewed. If the message already appears there, it will not be readded to the section.
 +
 +
The game can queue up to eight messages if there are multiple calls to print messages before the game finishes displaying them. The game displays the first message in the queue for the set duration. All messages in the queue are moved up after it is done. In a full queue, any additional messages are lost. For a call to print a normal message, the game places the message after the last message in the queue. For a call to print a now message, the game places the message in the first position of the queue, overwriting any message there. For a call to print a soon message, the game places the message in the second position of the queue and moves any message and subsequent messages down the queue. If the queue is empty, the game places it in the first position of the queue instead.
  
 
=== Mission script ===
 
=== Mission script ===

Latest revision as of 06:46, 30 July 2017

This page documents text displayed on the screen. For the text format stored in the games, see GXT.

Message

VC Message.png
A message displayed in Vice City.
VC Message widescreen.png
The same message but with widescreen switched on.

A message is text positioned on the bottom of the screen. The default text color of the message is white, which uses the token ~h~ in the GXT file. For Vice City and San Andreas, enabling widescreen repositions the message so that it appears centered and inside the black bars. This type of text is used extensively during cutscenes where messages can be hidden if the subtitles option is switched off. In the "Brief" section of the pause menu, the last few uniquely printed messages are added and can be viewed. If the message already appears there, it will not be readded to the section.

The game can queue up to eight messages if there are multiple calls to print messages before the game finishes displaying them. The game displays the first message in the queue for the set duration. All messages in the queue are moved up after it is done. In a full queue, any additional messages are lost. For a call to print a normal message, the game places the message after the last message in the queue. For a call to print a now message, the game places the message in the first position of the queue, overwriting any message there. For a call to print a soon message, the game places the message in the second position of the queue and moves any message and subsequent messages down the queue. If the queue is empty, the game places it in the first position of the queue instead.

Mission script

Opcodes

00BB GTA III Vice City San Andreas PRINT
00BC GTA III Vice City San Andreas PRINT_NOW
00BD GTA III PRINT_SOON
01E4 GTA III Vice City San Andreas PRINT_WITH_NUMBER
01E5 GTA III Vice City San Andreas PRINT_WITH_NUMBER_NOW
02FC GTA III PRINT_WITH_2_NUMBERS
02FD GTA III Vice City San Andreas PRINT_WITH_2_NUMBERS_NOW
02FE GTA III PRINT_WITH_2_NUMBERS_SOON
02FF GTA III Vice City San Andreas PRINT_WITH_3_NUMBERS
0300 GTA III PRINT_WITH_3_NUMBERS_NOW
0302 GTA III Vice City San Andreas PRINT_WITH_4_NUMBERS
0303 GTA III San Andreas PRINT_WITH_4_NUMBERS_NOW
0305 GTA III PRINT_WITH_5_NUMBERS
0306 GTA III PRINT_WITH_5_NUMBERS_NOW
0308 GTA III Vice City San Andreas PRINT_WITH_6_NUMBERS
0309 GTA III PRINT_WITH_6_NUMBERS_NOW
0375 GTA III PRINT_STRING_IN_STRING
0384 GTA III Vice City San Andreas PRINT_STRING_IN_STRING_NOW
0385 San Andreas PRINT_STRING_IN_STRING_SOON

Help message

A help message displayed in Vice City.

A help message is text positioned on the top left corner of the screen with a dark semi-transparent rectangular background. The default text color of the help message is gray, which uses the token ~w~ in the GXT file.

Mission script

The following tables list all opcodes and native functions related to help messages that can be used in a script.

Opcodes

03E5 GTA III Vice City San Andreas PRINT_HELP
03E6 GTA III Vice City San Andreas CLEAR_HELP
0512 Vice City San Andreas PRINT_HELP_FOREVER
0513 San Andreas PRINT_HELP_FOREVER_WITH_NUMBER
0517 Vice City San Andreas CREATE_LOCKED_PROPERTY_PICKUP
0518 Vice City San Andreas CREATE_FORSALE_PROPERTY_PICKUP
08FE San Andreas IS_HELP_MESSAGE_BEING_DISPLAYED
0989 San Andreas SET_HELP_MESSAGE_BOX_SIZE
0A2A San Andreas IS_THIS_HELP_MESSAGE_BEING_DISPLAYED

Native functions

GTA IV CLEAR_HELP
GTA IV PRINT_HELP
GTA IV PRINT_HELP_FOREVER

Hardcoded messages

The following table lists all help messages that are hardcoded into the games to print in certain events. Like all help messages, they can be cleared through the script.

Games GXT Event
GTA III Vice City CHEAT1 Inputting most cheats.
GTA III Vice City CHEAT2 Inputting weapon cheats.
GTA III Vice City CHEAT3 Inputting health cheat.
GTA III Vice City CHEAT4 Inputting armor cheat.
GTA III Vice City CHEAT5 Inputting wanted level cheats.
GTA III CHEAT6 Inputting money cheat.
GTA III Vice City CHEAT7 Inputting weather cheats.
GTA III CINCAM Selecting cinematic camera
GTA III Vice City GA_6 Acquiring car bomb with timed detonator at the bomb shop.
GTA III Vice City GA_6B
GTA III Vice City GA_7 Acquiring car bomb with engine ignition detonation at the bomb shop.
GTA III Vice City GA_7B
GTA III Vice City GA_8 Acquiring car bomb with remote-control detonator at the bomb shop.
GTA III Vice City GA_21 Attempting to open a garage that already has the maximum number of cars allowed.
Vice City PROP_1 Attempting to pickup a forsale property pickup without enough money.
Vice City PROP_2 Attempting to pickup a forsale property pickup while on a mission.
Vice City PU_CF1 Attempting to pick up a weapon that you already have of the same type.
Vice City PU_CF3
Vice City PU_CF4

Big message

One style of a big message displayed in Vice City.

A big message is a large styled text generally positioned on the center or bottom right side of the screen depending on the style of message. A big message can prioritize its display over other big messages of the same style. A high-priority big message immediately overwrites any other big messages of the same style currently being displayed. Any low-priority big messages will queue up until the one being currently displayed is finished. Big messages of styles 1 and 2 behave differently — their fading sequence must end before the overwriting text is displayed. They still obey the time duration so if the time duration for the overwriting text ends before it is displayed, it will not display at all.

Mission script

Opcodes

00BA GTA III Vice City San Andreas PRINT_BIG
01E3 GTA III Vice City San Andreas PRINT_WITH_NUMBER_BIG
0217 GTA III Vice City San Andreas PRINT_BIG_Q
0218 GTA III PRINT_WITH_NUMBER_BIG_Q
036D GTA III Vice City San Andreas PRINT_WITH_2_NUMBERS_BIG
036E GTA III PRINT_WITH_3_NUMBERS_BIG
036F GTA III PRINT_WITH_4_NUMBERS_BIG
0370 GTA III PRINT_WITH_5_NUMBERS_BIG
0371 GTA III PRINT_WITH_6_NUMBERS_BIG
03D6 GTA III Vice City San Andreas CLEAR_THIS_BIG_PRINT

Hardcoded messages

The following table lists of all big messages that are hardcoded into the games to print in certain events.

Games GXT Duration Style Event
GTA III Vice City BUSTED 5000 3 Being arrested
GTA III Vice City DEAD 4000 3 Being killed
Vice City GOODBOY 5000 1 Hitting a criminal being chased by a cop
Vice City TAXI 4500 2 Taking a taxi shortcut

Intro text

An intro text is created through the script and allows a large number of customizations to it. This type of text was initially used in GTA III's introduction sequence, hence the name, but subsequent games have used this type of text in various places. The following table lists all opcodes related to displaying this type of text.

Opcode Games Command Image
033E GTA III Vice City San Andreas DISPLAY_TEXT 033E 1024x768.png
033F GTA III Vice City San Andreas SET_TEXT_SCALE 033F.png
0340 GTA III Vice City San Andreas SET_TEXT_COLOUR 0340.png
0341 GTA III Vice City San Andreas SET_TEXT_JUSTIFY
0342 GTA III Vice City San Andreas SET_TEXT_CENTRE 0342.png
0343 GTA III Vice City San Andreas SET_TEXT_WRAPX 0343.png
0344 GTA III San Andreas SET_TEXT_CENTRE_SIZE 0344.png
0345 GTA III Vice City San Andreas SET_TEXT_BACKGROUND 0345.png
0346 GTA III SET_TEXT_BACKGROUND_COLOUR 0346.png
0347 GTA III SET_TEXT_BACKGROUND_ONLY_TEXT 0347.png
0348 GTA III Vice City San Andreas SET_TEXT_PROPORTIONAL 0348.png
0349 GTA III San Andreas SET_TEXT_FONT 0349.png
03E0 GTA III San Andreas SET_TEXT_DRAW_BEFORE_FADE
03E4 GTA III Vice City San Andreas SET_TEXT_RIGHT_JUSTIFY 03E4.png
03F0 GTA III Vice City San Andreas USE_TEXT_COMMANDS
045A GTA III Vice City San Andreas DISPLAY_TEXT_WITH_NUMBER
045B GTA III Vice City San Andreas DISPLAY_TEXT_WITH_2_NUMBERS

Garage message

A garage message is a large, blue styled text positioned at the center of the screen. All garage messages are hardcoded to print in certain events and cannot be triggered by the script.

Games GXT Duration Event
GTA III Vice City CO_ALL 5000 Collecting the last hidden package (pickup type 6)
GTA III Vice City CO_ONE 5000 Collecting a hidden package (pickup type 6)
GTA III Vice City CR_1 4000 Attempting to deliver a car a crusher crane cannot lift
GTA III Vice City GA_1 4000 Attempting to use a spray garage in a car it does not accept
GTA III Vice City GA_1A 5000 Attempting to deliver a mission car to an import export garage
GTA III Vice City GA_2 4000 Repairing and respraying a car at a spray garage
GTA III Vice City GA_3 4000 Attempting to use a spray garage with no money
GTA III Vice City GA_4 4000 Attempting to use a bomb shop with no money
GTA III Vice City GA_5 4000 Attempting to use a bomb shop in a car already fitted with a car bomb
GTA III Vice City GA_10 4000 Delivering a car to a military crane or to a garage that collects the specific car
GTA III GA_11 4000 Delivering more than ten Securicars or Police cars to a garage that collects the specific car
GTA III Vice City GA_12 3000 Arming a car bomb
GTA III Vice City GA_13 5000 Delivering a car to an import export garage
GTA III Vice City GA_14 5000 Delivering the last car to an import export garage
GTA III Vice City GA_15 4000 Respraying a car at a spray garage
GTA III Vice City GA_16 4000 Respraying a car at a spray garage
GTA III Vice City GA_19 4000 Attempting to deliver a car that a military crane does not accept
GTA III Vice City GA_19 5000 Attempting to deliver a car that an import export garage does not accept
GTA III Vice City GA_20 4000 Attempting to deliver a car that a military crane already has
GTA III Vice City GA_20 5000 Attempting to deliver a car that an import export garage already has
GTA III HM2_5 5000 Driving an RC Bandit into restricted zones
GTA III Vice City PU_MONY 6000 Attempting to buy a weapon with no money (pickup type 1)