# 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)
FlagsNative | 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

# Examples

# campaigns/liberty.sc2campaign

MapScript.galaxy

// L27165
UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, 6.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))
// L30676
UIShowTextCrawl(PlayerGroupAll(), ConversationDataStateText("Timestamps|Horner05S_Briefing", "Title"), ConversationDataStateText("Timestamps|Horner05S_Briefing", "Description"), 5.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))
// L30854
UIShowTextCrawl(PlayerGroupAll(), ConversationDataStateText("Timestamps|Tosh01_Briefing", "Title"), ConversationDataStateText("Timestamps|Tosh01_Briefing", "Description"), 5.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))
// L27165
UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, 6.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))
// L30676
UIShowTextCrawl(PlayerGroupAll(), ConversationDataStateText("Timestamps|Horner05S_Briefing", "Title"), ConversationDataStateText("Timestamps|Horner05S_Briefing", "Description"), 5.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))
// L30854
UIShowTextCrawl(PlayerGroupAll(), ConversationDataStateText("Timestamps|Tosh01_Briefing", "Title"), ConversationDataStateText("Timestamps|Tosh01_Briefing", "Description"), 5.0, SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))

# campaigns/swarmstory.sc2campaign

SwarmCampaignLib.galaxy

// L19695
UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("ConversationTimestamps", libSwaC_gv_zS_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))
// L19725
UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("ConversationTimestamps", libSwaC_gv_zS_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))

# campaigns/void.sc2campaign

MapScript.galaxy

// L9732
UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/37EFB928"), StringExternal("Param/Value/7CD26FB0"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1))
// L10103
UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/9D1081B9"), StringExternal("Param/Value/9E9AF8AB"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1))
// L10553
UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/E4EF3779"), StringExternal("Param/Value/49B58E8D"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1))
// L9732
UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/37EFB928"), StringExternal("Param/Value/7CD26FB0"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1))
// L10103
UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/9D1081B9"), StringExternal("Param/Value/9E9AF8AB"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1))
// L10553
UIShowTextCrawl(PlayerGroupAll(), StringExternal("Param/Value/E4EF3779"), StringExternal("Param/Value/49B58E8D"), 8.0, SoundLink("TextCrawlType", -1), SoundLink("UI_ObjectiveText", -1))

# campaigns/voidstory.sc2campaign

VoidCampaignLib.galaxy

// L10340
UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("Timestamps", libVoiC_gv_pC_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("UI_Void_TextCallout", -1))
// L10370
UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("Timestamps", libVoiC_gv_pC_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))

# mods/missionpacks/campaigncommon.sc2mod

LibComC.galaxy

// L4435
UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("Timestamps", libComC_gv_cC_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("UI_Void_TextCallout", -1))
// L4464
UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("Timestamps", libComC_gv_cC_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))

# mods/voidprologue.sc2mod

LibA3DDD02B.galaxy

// L8756
UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("ConversationTimestamps", libA3DDD02B_gv_pP_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))
// L8786
UIShowTextCrawl(PlayerGroupAll(), lv_title, lv_timestamp, UserDataGetFixed("ConversationTimestamps", libA3DDD02B_gv_pP_CutsceneTimestamp, "FlashDuration", 1), SoundLink("Silent", -1), SoundLink("TextCrawlType", -1))