# Show Text Crawl

Grammar — Display text crawl for players with title title, text text, and max duration maxTime seconds (play birthSound once, and loop typeSound as characters type)
Flags — Native | Action

Displays text that types out one character at a time over the specified duration.

# Arguments

playergroup — Players
text — Title
text — Text
fixed — Max Time
soundlink — Birth Sound
soundlink — Type Sound

Returns — void

native void UIShowTextCrawl(
	playergroup inPlayers,
	text inTitle,
	text inText,
	fixed inMaxTime,
	soundlink inBirthSoundLink,
	soundlink inTypeSoundLink,
);

Category: UI / Text

Hot Key String — text — UIHotKeyString
Text Message — void — UIDisplayMessage
Clear Text Messages — void — UIClearMessages
Show Cinematic Text — void — UIShowCinematicText
Hide Cinematic Text — void — UIHideCinematicText
Show Text Crawl — void — UIShowTextCrawl
Hide Text Crawl — void — UIHideTextCrawl
Error Message — void — libNtve_gf_UIErrorMessage

# Examples

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:27165

    lv_title = ConversationDataStateText(gv_convoIDGlobal, "Title");
    Wait(1.0, c_timeReal);
    UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, 6.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    Wait(6.0, c_timeReal);
    return true;

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:30676

    }

    UIShowTextCrawl(PlayerGroupAll(), ConversationDataStateText("Timestamps|Horner05S_Briefing", "Title"), ConversationDataStateText("Timestamps|Horner05S_Briefing", "Description"), 5.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    return true;
}

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:30854

    }

    UIShowTextCrawl(PlayerGroupAll(), ConversationDataStateText("Timestamps|Tosh01_Briefing", "Title"), ConversationDataStateText("Timestamps|Tosh01_Briefing", "Description"), 5.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    return true;
}

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:27165

    lv_title = ConversationDataStateText(gv_convoIDGlobal, "Title");
    Wait(1.0, c_timeReal);
    UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, 6.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    Wait(6.0, c_timeReal);
    return true;

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:30676

    }

    UIShowTextCrawl(PlayerGroupAll(), ConversationDataStateText("Timestamps|Horner05S_Briefing", "Title"), ConversationDataStateText("Timestamps|Horner05S_Briefing", "Description"), 5.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    return true;
}

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:30854

    }

    UIShowTextCrawl(PlayerGroupAll(), ConversationDataStateText("Timestamps|Tosh01_Briefing", "Title"), ConversationDataStateText("Timestamps|Tosh01_Briefing", "Description"), 5.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    return true;
}

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:19695

    lv_title = UserDataGetText("ConversationTimestamps", libSwaC_gv_zS_CutsceneTimestamp, "Title", 1);
    Wait(UserDataGetFixed("ConversationTimestamps", libSwaC_gv_zS_CutsceneTimestamp, "StartDelay", 1), c_timeReal);
    UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("ConversationTimestamps", libSwaC_gv_zS_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    Wait(UserDataGetFixed("ConversationTimestamps", libSwaC_gv_zS_CutsceneTimestamp, "WaitDuration", 1), c_timeReal);
    return true;

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:19725

    TriggerSkippableBegin(PlayerGroupAll(), 0, null, true, false);
    Wait(UserDataGetFixed("ConversationTimestamps", libSwaC_gv_zS_CutsceneTimestamp, "StartDelay", 1), c_timeReal);
    UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("ConversationTimestamps", libSwaC_gv_zS_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    Wait(UserDataGetFixed("ConversationTimestamps", libSwaC_gv_zS_CutsceneTimestamp, "WaitDuration", 1), c_timeReal);
    return true;

campaigns/void.sc2campaign — base.sc2maps/maps/campaign/void/paiur04.sc2map/MapScript.galaxy:9732

    UnitIssueOrder(gv_vorazun, OrderTargetingPoint(AbilityCommand("move", 0), PointFromId(19)), c_orderQueueReplace);
    CinematicFade(true, 1.0, c_fadeStyleNormal, Color(0.00, 0.00, 0.00), 0.0, true);
    UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/37EFB928"), StringExternal("Param/Value/7CD26FB0"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1));
    Wait(5.0, c_timeGame);
    UIHideTextCrawl(PlayerGroupAll());

campaigns/void.sc2campaign — base.sc2maps/maps/campaign/void/paiur04.sc2map/MapScript.galaxy:10103

    CameraApplyInfo(gv_pLAYER_01_USER, CameraInfoFromId(911), 5.0, -1, 10, true);
    CinematicFade(true, 1.0, c_fadeStyleNormal, Color(0.00, 0.00, 0.00), 0.0, false);
    UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/9D1081B9"), StringExternal("Param/Value/9E9AF8AB"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1));
    Wait(5.0, c_timeGame);
    UIHideTextCrawl(PlayerGroupAll());

campaigns/void.sc2campaign — base.sc2maps/maps/campaign/void/paiur04.sc2map/MapScript.galaxy:10553

    CameraApplyInfo(gv_pLAYER_01_USER, CameraInfoFromId(3500), 5.0, -1, 10, true);
    CinematicFade(true, 1.0, c_fadeStyleNormal, Color(0.00, 0.00, 0.00), 0.0, false);
    UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/E4EF3779"), StringExternal("Param/Value/49B58E8D"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1));
    Wait(5.0, c_timeReal);
    UIHideTextCrawl(PlayerGroupAll());

campaigns/void.sc2campaign/base.sc2maps/maps/campaign/void/paiur04.sc2map — MapScript.galaxy:9732

    UnitIssueOrder(gv_vorazun, OrderTargetingPoint(AbilityCommand("move", 0), PointFromId(19)), c_orderQueueReplace);
    CinematicFade(true, 1.0, c_fadeStyleNormal, Color(0.00, 0.00, 0.00), 0.0, true);
    UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/37EFB928"), StringExternal("Param/Value/7CD26FB0"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1));
    Wait(5.0, c_timeGame);
    UIHideTextCrawl(PlayerGroupAll());

campaigns/void.sc2campaign/base.sc2maps/maps/campaign/void/paiur04.sc2map — MapScript.galaxy:10103

    CameraApplyInfo(gv_pLAYER_01_USER, CameraInfoFromId(911), 5.0, -1, 10, true);
    CinematicFade(true, 1.0, c_fadeStyleNormal, Color(0.00, 0.00, 0.00), 0.0, false);
    UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/9D1081B9"), StringExternal("Param/Value/9E9AF8AB"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1));
    Wait(5.0, c_timeGame);
    UIHideTextCrawl(PlayerGroupAll());

campaigns/void.sc2campaign/base.sc2maps/maps/campaign/void/paiur04.sc2map — MapScript.galaxy:10553

    CameraApplyInfo(gv_pLAYER_01_USER, CameraInfoFromId(3500), 5.0, -1, 10, true);
    CinematicFade(true, 1.0, c_fadeStyleNormal, Color(0.00, 0.00, 0.00), 0.0, false);
    UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/E4EF3779"), StringExternal("Param/Value/49B58E8D"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1));
    Wait(5.0, c_timeReal);
    UIHideTextCrawl(PlayerGroupAll());

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:10340

    lv_title = UserDataGetText("Timestamps", libVoiC_gv_pC_CutsceneTimestamp, "Title", 1);
    Wait(UserDataGetFixed("Timestamps", libVoiC_gv_pC_CutsceneTimestamp, "StartDelay", 1), c_timeReal);
    UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("Timestamps", libVoiC_gv_pC_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("UI_Void_TextCallout", -1));
    Wait(UserDataGetFixed("Timestamps", libVoiC_gv_pC_CutsceneTimestamp, "WaitDuration", 1), c_timeReal);
    return true;

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:10370

    TriggerSkippableBegin(PlayerGroupAll(), 0, null, true, false);
    Wait(UserDataGetFixed("Timestamps", libVoiC_gv_pC_CutsceneTimestamp, "StartDelay", 1), c_timeReal);
    UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("Timestamps", libVoiC_gv_pC_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    Wait(UserDataGetFixed("Timestamps", libVoiC_gv_pC_CutsceneTimestamp, "WaitDuration", 1), c_timeReal);
    return true;

mods/missionpacks/campaigncommon.sc2mod — base.sc2data/LibComC.galaxy:4435

    lv_title = UserDataGetText("Timestamps", libComC_gv_cC_CutsceneTimestamp, "Title", 1);
    Wait(UserDataGetFixed("Timestamps", libComC_gv_cC_CutsceneTimestamp, "StartDelay", 1), c_timeReal);
    UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("Timestamps", libComC_gv_cC_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("UI_Void_TextCallout", -1));
    Wait(UserDataGetFixed("Timestamps", libComC_gv_cC_CutsceneTimestamp, "WaitDuration", 1), c_timeReal);
    return true;

mods/missionpacks/campaigncommon.sc2mod — base.sc2data/LibComC.galaxy:4464

    TriggerSkippableBegin(PlayerGroupAll(), 0, null, true, false);
    Wait(UserDataGetFixed("Timestamps", libComC_gv_cC_CutsceneTimestamp, "StartDelay", 1), c_timeReal);
    UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("Timestamps", libComC_gv_cC_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    Wait(UserDataGetFixed("Timestamps", libComC_gv_cC_CutsceneTimestamp, "WaitDuration", 1), c_timeReal);
    return true;

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:8756

    lv_title = UserDataGetText("ConversationTimestamps", libA3DDD02B_gv_pP_CutsceneTimestamp, "Title", 1);
    Wait(UserDataGetFixed("ConversationTimestamps", libA3DDD02B_gv_pP_CutsceneTimestamp, "StartDelay", 1), c_timeReal);
    UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("ConversationTimestamps", libA3DDD02B_gv_pP_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    Wait(UserDataGetFixed("ConversationTimestamps", libA3DDD02B_gv_pP_CutsceneTimestamp, "WaitDuration", 1), c_timeReal);
    return true;

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:8786

    TriggerSkippableBegin(PlayerGroupAll(), 0, null, true, false);
    Wait(UserDataGetFixed("ConversationTimestamps", libA3DDD02B_gv_pP_CutsceneTimestamp, "StartDelay", 1), c_timeReal);
    UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("ConversationTimestamps", libA3DDD02B_gv_pP_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1));
    Wait(UserDataGetFixed("ConversationTimestamps", libA3DDD02B_gv_pP_CutsceneTimestamp, "WaitDuration", 1), c_timeReal);
    return true;

# Show Text Crawl

# Arguments

# Related

# Examples