Cutscene

From GTAMods Wiki
Revision as of 13:20, 28 April 2012 by Solom (talk | contribs) (→‎GTA IV)
Jump to navigation Jump to search

Cutscenes are short, pre-animated sequences before, during or after missions. Their purpose is to advance the plot and give background information about characters, situations and actions.

San Andreas Cutscenes

In San Andreas cutscenes are only loaded using main.scm. However, camera movement during cutscenes can't be controlled via script. This data is usually stored externally in the anim\cuts.img archive. Each cutscene consists of 3 files with the same name and a different extension: .cut, .ifp and .dat.

Whilst modification of existing cutscenes is possible through the files detailed below, new cutscenes cannot be added to the game unless they have a filename that already exists. This is due to the presence of an internally hardcoded table which links each cutscene (the .cut, .ifp and .dat files) to its audio streams and it does so by cutscene filename.

Cutscene data

The CUT File

The .cut file is loaded first. It contains the important data of the cutscene like its offset and the loaded models. The models of an cutscene are usually stored in the models\cutscene.img archive. It's split up into certain sections. Not every cut-file requires all sections, but it is better to include all sections into a cut-file and leave unused sections empty.

INFO

The info section contains information to the offset. It describes the 3D-coords of a point to which all other coords in the rest of the files are relative. Its format is 

info
offset X Y Z
end

The offset parameter can also be set using opcode 0244.

MODEL

The model section contains information about models the cutscene uses. The models don't need to be defined in the IDEs. But the texture name must be the same as the model's one. The model section also attaches models to animations in the IFP-animation archive. Its format is: 

model
?, name, animation
end

Where the name is without extension, and the animation describes an entry in the IFP file. The unknown value is a number, which is always 1 and actually is ignored by the game.
There is a Limit to 50 entries here!

EXTRACOL

Extracol stands for "Extracolor" and sets the active interior's color. It corresponds to the opcode 04F9. 

extracol
Number
end

Extracolours can be edited in the timecyc.dat.

TEXT

The text section displays a GXT entry at an certain point of time relative to the cutscene start. 

text
starttime, length, gxt
end

Where the numbers are integer and define the time in milliseconds.

UNCOMPRESS

the uncompress-section uncompresses the IFP animations. 

uncompress
Animation
end
PEFFECT

stands for the particle effect and sets an particle effect from the effects.fxp. 

peffect
effectname, starttime, endtime, unknown_number, bone, X, Y, Z, ?, ?, ?
end

The bone is a number of the body part the particle effect is attached to.

REMOVE

Removes an static (IPL-mapped) object being placed at specified coord. 

remove
Objectname, X, Y, Z
end
ATTACH

Actually the content and use of this section is unknown. It is rarely used. 

attach
Number, Number, Number
end
MOTION

This section is ignored by the game!

The DAT-File

The dat-file contains information about the camera movements during the cutscene.

It consists of 4 blocks:

  • Block1: Rotation
  • Block2: Zoom
  • Block3: CameraPositions
  • Block4: CameraTargetPoints

Each block starts with an integer number being the number of entries in this block, followed by its content and ended by a semicolon. The whole file is also marked as finished with an additional semicolon. Each line is marked as finished by an simple comma. The file describes 3 lanes, where the last 2 ones are ignored. So those 3 lines could be set identically by editors. This gives a general format: 

TimeOffset,Lane1,Lane2,Lane3,

The TimeOffset is an floating value which defines the time of the event in seconds. The game interpolates the curve between the 2 points.

Block1 - Rotation
TimeOffset,Rotation(Lane_1),Rotation(Lane_2),Rotation(Lane_3),

Describes the rotation around the vector towards the target point in euler angles (degree).

Block2 - Zoom
TimeOffset,Zoom(Lane_1),Zoom(Lane_2),Zoom(Lane_3),

Defines the focal of the camera for each lane.

Block3 - Cameraposition
TimeOffset,X(Lane_1),Y(Lane_1),Z(Lane_1),X(Lane_2),Y(Lane_2),Z(Lane_2),X(Lane_3),Y(Lane_3),Z(Lane_3),

Defines the position of the camera relative to the offset point.

Block4 - Target
TimeOffset,X(Lane_1),Y(Lane_1),Z(Lane_1),X(Lane_2),Y(Lane_2),Z(Lane_2),X(Lane_3),Y(Lane_3),Z(Lane_3),

Defines the position of the target of the camera relative to the offset-point.

The IFP animation archive

This is an ANPK (Animation Package v1 | GTA III/VC) IFP file including the animations used for the cutscene. For the file specification look here: IFP Animations. The positions of the bones and animated objects in the animation are relative to the offset defined in the INFO section of the .cut file.

List of Cutscenes in San Andreas

SCM (OpCodes)

  • 0244 - SetsCutscenePosition
  • 02E4 - LoadsCutsceneData
  • 02E7 - StartsCutscene
  • 02E8 - GetsCutsceneTime
  • 02E9 - HasCutsceneReachedEnd
  • 02EA - EndsCutscene
  • 03B7 - ProcessCutsceneOnly
  • 06B9 - IsCutsceneDataLoaded
  • 08D0 - IsCutsceneSkipped
  • 08F0 - SetsCutsceneModelTexture

GTA IV

Cutscenes in GTA IV used .WAD, .CUT and .model files for cutscenes. Cut files of this game is used tags. List and description of these tags are discussed below. GTA IV Cutscene contain a tags. One cutscene may contain about 15 sections. Tags DRAW_DISTANCE, FLAGS, BLOCKING_BOUNDS, CAMCORDER, TEXT, as usual, are not used within the sections.

Sections for .cut (GTA 4) was researched by - DK22PAC & Solom.

Tags description

ID:0 - SECTION_START

The tag indicates the start of the section cutscene.

ID:0 - SECTION_END

The tag indicates the end of the section cutscene.

ID:1 - OFFSET

A point that defines the beginning of the coordinate system cutscene 

float X, float Y, float Z

Example: 

[OFFSET]
-109.416000 -265.023010 14.785000
[/OFFSET]
ID:2 - CUTSCENE_HEADER

Unknown section.

Note: Parameters of this section is not used by the game, but they must be present.

ID:3 - DURATION

determines the length of sections.

Example: 

[DURATION]
45466.667969
[/DURATION]
ID:4 - ANIM

File Name of WAD, that contain animations for cutscene. 

string WADName

Usually, this is <cutscene name>_<ID section>

Example: 

[ANIM]
RB_1_1
[/ANIM]
ID:5 - MODELS

Contain info about subject, that are present in the cutscene, their models and animations. 

int ID, string ModelName, string AnimName, string HeadAnimName, int Unknown
  • ID - object identifier that can be used in other tags
  • ModelName - model name (models for cutscene placed in cutsprops.img)
  • AnimName - animation name for the subject WAD file
  • HeadAnimName - The name of the person's face animations from WAD file

One section in cutscene may to use 570 subjects.

Example: 

[MODELS]
0 CS_Davethemate CS_Davethemate_0 Davethemate_head_0
1 player player_0 player_head_0
2 CS_Hossan CS_Hossan_0 cs_hossan_head_0 0
3 CS_WhippingGirl CS_WhippingGirl_0
4 csWhip csWhip_0
5 csToolBox csToolBox_0
[/MODELS]


Sections, ignored by the game

ID:22 - PLAYER_START

ID:23 - MISSION_TEXT_NAME

Note: These two parameters used only in .SCO, so these sections is ignored by the game.

ORIENT

TIME

ANIMRANGE

COMPRESSION

SCO (Native functions) for cutscenes

CLEAR_CUTSCENE

CLEAR_NAMED_CUTSCENE

EXPLODE_CAR_IN_CUTSCENE

EXPLODE_CAR_IN_CUTSCENE_SHAKE_AND_BIT

GET_CUTSCENE_TIME

GET_CUTSCENE_AUDIO_TIME_MS

GET_CUTSCENE_PED_POSITION

GET_CUTSCENE_SECTION_PLAYING

HIDE_CHAR_WEAPON_FOR_SCRIPTED_CUTSCENE

HAS_CUTSCENE_FINISHED

HAS_CUTSCENE_LOADED

INIT_CUTSCENE

IS_PED_IN_CUTSCENE_BLOCKING_BOUNDS

IS_PLAYER_READY_FOR_CUTSCENE

IS_POS_IN_CUTSCENE_BLOCKING_BOUNDS

MAKE_PLAYER_SAFE_FOR_CUTSCENE

SET_CAR_IN_CUTSCENE

SET_CHAR_IN_CUTSCENE

SET_CUTSCENE_EXTRA_ROOM_POS

SHAKE_PAD_IN_CUTSCENE

START_CUTSCENE_NOW

START_CUTSCENE - Don't used (?)

SET_CUTSCENE_EXTRA_ROOM_POS

WAS_CUTSCENE_SKIPPED

External link

v · d · e
GTA IV Grand Theft Auto IV
File Formats.dat • .gxt • .ide • .img • .ipl • .nod • .sco • .rpf • .rrr • .wad • .wbd/.wbn • .wdd • .wdr • .wft • .whm • .wpl • .wtd
DocumentationAudio • Bink Video • Cryptography • Cutscenes • GXT Text • Image listing • Keycodes • Map Listing • Native functions • Paths • Radar Blips • Radio Stations • Saves • Scenarios • VTable • Weapons
ToolsASI Loader • ENBSeries • G-Texture • GIMS IV • Ingame WPL Editor • IV Needle • OpenIV • SparkIV • XLiveLess • WPL Manager • X Mod Installer
Alice • C++ Script Hook • .NET Script Hook • Scocl
TutorialsImporting Textures with OpenIV • Importing Textures with SparkIV
ModificationsGTA Connected • Gostown IV • Four Multiplayer • IV Multiplayer • CitizenMP:IV Reloaded
Useful linksCommunity portal • Discussion forums • Modding forums • Mods on GTAGarage.com
v · d · e
San Andreas Grand Theft Auto: San Andreas
File Formats.b • .col • .cfg • .cut • .dff • .dat • .fxp • .gxt • .ide • .ifp • .img • .ipl • nodes*.dat • .ped • .rep • .rrr • .scm • .set • .txd
DocumentationAudio • Cryptography • Cutscenes • Game memory • Handling.cfg • Map Listing • Mission Packs • Instructions • Paths • Replays • Saves • Scripts • Sound Effects • Statistics • Vehicles • Wanted levels
ToolsCLEO • Collision File Editor II • ENBSeries • G-Tools • IMG Tool • Limit Adjuster • Map Editor • Mod Loader • San Andreas Audio Toolkit • Sanny Builder • TXD Workshop • Magic.TXD
TutorialsSan Andreas v2.0 Modding • How to create a mission • How to create a script • How to use Map Editor • Vehicle Mod Installation
ModificationsDesign Your Own Mission • Gostown Paradise • GTA: United • Myriad Islands
MultiplayergtaTournament • Multi Theft Auto • San Andreas Multiplayer • (more...)
Useful linksCommunity Portal • Discussion Forums • Modding Forums • Mods on GTAGarage.com • Mobile Modding • Opcodes Database
Retrieved from "https://gtamods.com/mediawiki/index.php?title=Cutscene&oldid=10848"