mission_dialogue_data¶

Source: base/tealdef/mission/tasks/mission_dialogue_data.d.tl

Notes

Data format of dialogue and cutscene keyframe files and of task instructions.

MissionDialogueData¶

record global base/tealdef/mission/tasks/mission_dialogue_data.d.tl:3

global record MissionDialogueData

Notes

Data format of dialogue and cutscene keyframe files (function data() return { ... } end) and of task instructions. Times and durations are in seconds.

MissionDialogueData.CameraFrame¶

record base/tealdef/mission/tasks/mission_dialogue_data.d.tl:4

record CameraFrame

Notes

Camera keyframe of a cutscene.

Fields

Name	Type	Description
`angle`	`number`	Camera yaw.
`fovY`	`number`	Vertical field of view.
`pitch`	`number`	Camera pitch.
`position`	`Vec3f`	Camera position.
`roll`	`number`	Camera roll.
`skyRotation`	`number`	Rotation of the sky.
`speed`	`number`	Speed of the camera movement.
`time`	`number`	Time of the keyframe in seconds.

MissionDialogueData.Fade¶

record base/tealdef/mission/tasks/mission_dialogue_data.d.tl:15

record Fade

Notes

Fade to and from black.

Fields

Name	Type	Description
`duration`	`number`	Length of the fade in seconds.
`fadeIn`	`number`	Fade-in time.
`fadeOut`	`number`	Fade-out time.
`time`	`number`	Start time in seconds.

MissionDialogueData.Subtitle¶

record base/tealdef/mission/tasks/mission_dialogue_data.d.tl:22

record Subtitle

Notes

Subtitle line.

Used in the base game: 5 times in 1 file

base/content/mission/mission/mission_react_util.tl:129

local getSubtitle = function(subtitles : { MissionDialogueData.Subtitle }, time : number) : string

Fields

Name	Type	Description
`duration`	`number`	Display time in seconds.
`text`	`string`	Text, usually a translation key passed through `_()`.
`time`	`number`	Start time in seconds.

MissionDialogueData.VoiceOver¶

record base/tealdef/mission/tasks/mission_dialogue_data.d.tl:28

record VoiceOver

Notes

Voice-over sound.

Used in the base game: 2 times in 1 file

base/content/mission/mission/mission_react_util.tl:113

local getSkipOffset = function(voiceOvers : {MissionDialogueData.VoiceOver}, time : number) : number

Fields

Name	Type	Description
`fileName`	`string`	Sound file (`.wav`).
`time`	`number`	Start time in seconds.

MissionDialogueData.Portrait¶

record base/tealdef/mission/tasks/mission_dialogue_data.d.tl:33

record Portrait

Notes

Character portrait shown next to the subtitles.

Used in the base game: 1 time in 1 file

base/content/mission/mission/mission_react_util.tl:158

local getPortrait = function(portraits: { MissionDialogueData.Portrait }, time : number) : string

Fields

Name	Type	Description
`duration`	`number`	Display time in seconds.
`path`	`string`	Image file.
`time`	`number`	Start time in seconds.

MissionDialogueData.DialogueData¶

record base/tealdef/mission/tasks/mission_dialogue_data.d.tl:39

record DialogueData

Notes

Content of a dialogue or cutscene keyframe file.

Example

-- urbangames_campaign_mission_01: keyframes/en/MISSION_01_CUTSCENE_BRIDGE_COMPLETE.lua
function data()
return {
    camera = {},
    fades = {},
    music = "",
    portraits = {
        { duration = 8.77, path = "urbangames_campaign_mission_01::/mission/dialogue/katie_baker_neutral.tga", time = 0 },
    },
    subtitles = {
        { duration = 8.27, text = _("MISSION_01_CUTSCENE_BRIDGE_COMPLETE_1"), time = 0.5 },
    },
    voiceOvers = {
        { fileName = "urbangames_campaign_mission_01::/audio/voice_over/MISSION_01_CUTSCENE_BRIDGE_COMPLETE_1.wav", time = 0.5 },
    },
}
end

Used in the base game: 10 times in 1 file

base/content/mission/mission/mission_react_util.tl:233

local breakUpLongSubtitleStrings = function(data : MissionDialogueData.DialogueData) : MissionDialogueData.DialogueData

Fields

Name	Type	Description
`camera`	`{CameraFrame}`	Camera keyframes.
`fades`	`{Fade}`	Fades.
`music`	`string`	Music file; empty for none.
`subtitles`	`{Subtitle}`	Subtitle lines.
`voiceOvers`	`{VoiceOver}`	Voice-over sounds.
`portraits`	`{Portrait}`	Portraits.

MissionDialogueData.InstructionData¶

record base/tealdef/mission/tasks/mission_dialogue_data.d.tl:48

record InstructionData

Notes

Single voice-over instruction of a task, played from the task window.

Used in the base game: 26 times in 10 files

base/content/mission/mission/mission_react_util.tl:423

instructionData : MissionDialogueData.InstructionData

base/content/mission/mission/mission_framework/mission_framework_react.tl:1092

dialogueApi.enqueueUnlessExisting(taskUid, queueEntry.instructionKey, function() : MissionDialogueData.InstructionData

mods/release/urbangames_campaign_mission_07/content/mission/mission/mission_story.tl:579

makeInstructionData = function(key: string) : MissionDialogueData.InstructionData

mods/release/urbangames_campaign_mission_02/content/mission/mission/mission_story.tl:585

makeInstructionData = function(key: string) : MissionDialogueData.InstructionData

mods/release/urbangames_campaign_mission_06/content/mission/mission/mission_story_cutscene_only.tl:135

fails : {MissionDialogueData.InstructionData}

mods/release/urbangames_campaign_mission_06/content/mission/mission/mission_story.tl:149

fails : {MissionDialogueData.InstructionData}

… and 4 more files.

Fields

Name	Type	Description
`subtitle`	`string`	Subtitle text.
`voiceOver`	`string`	Sound file.
`portrait`	`string`	Portrait image of the speaker.
`duration`	`number`	Length in seconds.