Перейти к содержимому
Документация описывает SGC Loading Screen 2.5.0, версия скоро появится на FAB. Сейчас на FAB — 1.0.0.

API Blueprint

USGCAsync Action Wait for All Players (перевод отсутствует)

Заголовок раздела «USGCAsync Action Wait for All Players (перевод отсутствует)»

Ждёт, пока сервер сообщит, что все игроки загрузили текущую карту (Wait For All Players).

Waits until all players have loaded the current map, then fires On Ready. Call it after the map has loaded, for example before Dismiss Loading Screen in the manual modes. Fires at once when Wait For All Players is off or the game is not networked. Timed Out: the server stopped waiting because some players did not load in time. On a dedicated server, waits for the server’s current map readiness and uses only the server’s player wait timeout. If no player wait has started, keeps waiting until one starts or the world is cleaned up. World cleanup ends the wait without firing On Ready. (перевод отсутствует)

static USGCAsyncAction_WaitForAllPlayers* WaitForAllPlayersReady()
Параметр Тип Направление По умолчанию Примечание
ReturnValue USGCAsyncAction_WaitForAllPlayers* output — —

FSGCAllPlayersReadyDelegate OnReady
Параметр Тип Направление По умолчанию Примечание
bTimedOut bool output — —

USGCAsync Action Wait Loading Screen Dismissed (перевод отсутствует)

Заголовок раздела «USGCAsync Action Wait Loading Screen Dismissed (перевод отсутствует)»

Ожидание (только успех), пока экран загрузки не скроется (после затухания по Dismiss).

Ждёт, пока экран загрузки скроется после затухания Dismiss. Срабатывает в следующем кадре, если экран не показан и не запрошен, и на dedicated server (там экрана нет).

static USGCAsyncAction_WaitLoadingScreenDismissed* WaitForLoadingScreenDismissed()
Параметр Тип Направление По умолчанию Примечание
ReturnValue USGCAsyncAction_WaitLoadingScreenDismissed* output — —

FSGCLoadingScreenDismissedAsyncDelegate OnDismissed

USGCAsync Action Wait Loading Screen Shown (перевод отсутствует)

Заголовок раздела «USGCAsync Action Wait Loading Screen Shown (перевод отсутствует)»

Waits for the current pending request, or the next request when idle, to show its screen. (перевод отсутствует)

Waits until the current pending request is shown; when idle, waits for the next request. An already visible or fading screen succeeds on the next frame with its captured request context. Cancellation before showing, failure to create a screen, and an unavailable screen subsystem use On Not Shown. A dedicated server is Unavailable. No timeout is applied. Showing does not mean loading has completed. (перевод отсутствует)

static USGCAsyncAction_WaitLoadingScreenShown* WaitForLoadingScreenShown()
Параметр Тип Направление По умолчанию Примечание
ReturnValue USGCAsyncAction_WaitLoadingScreenShown* output — —

The screen reached Visible. Context identifies the request, even if it has since finished. (перевод отсутствует)

FSGCLoadingScreenShownAsyncDelegate OnShown
Параметр Тип Направление По умолчанию Примечание
Context FSGCLoadingScreenContext output — —

The request was cancelled before showing, failed to show, or has no available screen subsystem. (перевод отсутствует)

FSGCLoadingScreenNotShownAsyncDelegate OnNotShown
Параметр Тип Направление По умолчанию Примечание
Outcome ESGCLoadingScreenShownOutcome output — —

USGCAsync Action Watch PSOPrecompile (перевод отсутствует)

Заголовок раздела «USGCAsync Action Watch PSOPrecompile (перевод отсутствует)»

Следит за предкомпиляцией PSO (графические конвейеры под эту видеокарту и драйвер; долго при первом запуске сборки). Плагин не держит из-за неё игроков: решает ваша игра, например показывает уведомление или предупреждает перед «Новой игрой».

On Started: идёт предкомпиляция (Total — сколько PSO оставалось, когда наблюдение началось). On Progress: Remaining и Progress (0..1), не чаще 10 раз в секунду. On Finished: предкомпилировать больше нечего (Seconds — сколько длилось наблюдение). Срабатывает при первой проверке (0,1 с), если сейчас ничего не идёт.

static USGCAsyncAction_WatchPSOPrecompile* WatchPSOPrecompile()
Параметр Тип Направление По умолчанию Примечание
ReturnValue USGCAsyncAction_WatchPSOPrecompile* output — —

FSGCPSOPrecompileStartedDelegate OnStarted
Параметр Тип Направление По умолчанию Примечание
Total int32 output — —

FSGCPSOPrecompileProgressDelegate OnProgress
Параметр Тип Направление По умолчанию Примечание
Remaining int32 output — —
Progress float output — —

FSGCPSOPrecompileFinishedDelegate OnFinished
Параметр Тип Направление По умолчанию Примечание
Seconds float output — —

USGCLoading Screen Blueprint Library (перевод отсутствует)

Заголовок раздела «USGCLoading Screen Blueprint Library (перевод отсутствует)»

Blueprint-доступ к экрану загрузки игрового экземпляра.

Requests the loading screen for the current game instance. Available in every mode. A visible request is kept; an ordinary dismiss fade is cancelled. A fade forced by Max Visible Secs cannot be cancelled; request a new screen after it finishes. (перевод отсутствует)

static void PushLoadingScreen()

Cancels a pending request, or fades out the visible screen even if loading or holds remain. With Continue On Input enabled, releases the manual gate instead: closing waits until loading reaches 100% and a new key, mouse button, gamepad button or touch confirms. Max Visible Secs can force closing. Available in every mode. Wait For Loading Screen Dismissed fires after the screen is removed. (перевод отсутствует)

static void DismissLoadingScreen()

Returns the Game Instance event source for shown, dismiss-started and finished notifications. Null when screens are unavailable. (перевод отсутствует)

static USGCLoadingScreenEvents* GetLoadingScreenEvents()
Параметр Тип Направление По умолчанию Примечание
ReturnValue USGCLoadingScreenEvents* output — —

Returns Unavailable without a screen subsystem (including a dedicated server), otherwise its current lifecycle state. (перевод отсутствует)

static ESGCLoadingScreenState GetLoadingState()
Параметр Тип Направление По умолчанию Примечание
ReturnValue ESGCLoadingScreenState output — —

Set Loading Screen Continue On Input (перевод отсутствует)

Заголовок раздела «Set Loading Screen Continue On Input (перевод отсутствует)»

Changes Continue On Input for this Game Instance without writing Project Settings. Applies to the visible screen and future requests. Disabling releases its continue gate immediately. When enabled, closing waits for new discrete input after 100% progress; in manual modes Dismiss must release the manual gate too. Repeats, analog input, console/PIE exceptions and MoviePlayer input do not confirm. Each network machine waits independently. Max Visible Secs still closes the screen. (перевод отсутствует)

static void SetLoadingScreenContinueOnInput(bool bEnabled)
Параметр Тип Направление По умолчанию Примечание
bEnabled bool input — —

Returns the displayed loading progress from 0 to 1. Resets for each new load cycle. Returns 0 without a screen. (перевод отсутствует)

static float GetLoadingProgress()
Параметр Тип Направление По умолчанию Примечание
ReturnValue float output — —

Возвращает, прикреплён ли сейчас экран загрузки к viewport.

static bool IsLoadingScreenVisible()
Параметр Тип Направление По умолчанию Примечание
ReturnValue bool output — —

Возвращает активный виджет экрана загрузки или null, если экран сейчас не показан.

static USGCLoadingScreenWidget* GetActiveLoadingScreenWidget()
Параметр Тип Направление По умолчанию Примечание
ReturnValue USGCLoadingScreenWidget* output — —

Вызывает Set Custom Text 1 у активного экрана загрузки. Ничего не делает, если экран не показан.

static void SetCustomText1(const FText& CustomText)
Параметр Тип Направление По умолчанию Примечание
CustomText const FText& input — —

Устарело Замена — Use Add Loading Tips and the SGC Loading Tip widget. Still works.

Вызывает Set Custom Text 2 у активного экрана загрузки. Ничего не делает, если экран не показан.

static void SetCustomText2(const FText& CustomText)
Параметр Тип Направление По умолчанию Примечание
CustomText const FText& input — —

Устарело Замена — Use Add Loading Tips and the SGC Loading Tip widget. Still works.

Вызывает Set Custom Text 3 у активного экрана загрузки. Ничего не делает, если экран не показан.

static void SetCustomText3(const FText& CustomText)
Параметр Тип Направление По умолчанию Примечание
CustomText const FText& input — —

Устарело Замена — Use Add Loading Tips and the SGC Loading Tip widget. Still works.

Вызывает Set Custom Progress у активного экрана загрузки. Ничего не делает, если экран не показан.

static void SetCustomProgress(float Progress)
Параметр Тип Направление По умолчанию Примечание
Progress float input — —

Вызывает Notify Custom у активного экрана загрузки. Не закрывает экран. Ничего не делает, если экран не показан.

static void NotifyCustom()

Вызывает Set Custom Image у активного экрана загрузки. Ничего не делает, если экран не показан.

static void SetCustomImage(UTexture2D* CustomImage)
Параметр Тип Направление По умолчанию Примечание
CustomImage UTexture2D* input — —

Устарело Замена — Use Add Loading Backgrounds and the SGC Loading Background widget. Still works.

Saves the player’s motion preference in GameUserSettings.ini, overriding Project Settings. Applies immediately to all current loading screens on this machine; startup uses it from the next launch. Widget animations and movies are unaffected. (перевод отсутствует)

static void SetLoadingScreenReduceMotion(bool bReduceMotion)
Параметр Тип Направление По умолчанию Примечание
bReduceMotion bool input — —

Returns the saved player preference, or the project default when no player choice has been saved. (перевод отсутствует)

static bool GetLoadingScreenReduceMotion()
Параметр Тип Направление По умолчанию Примечание
ReturnValue bool output — —

Держит экран загрузки по причине вашей игры (например, LoadingScreen.Hold.Quests), с необязательным прогрессом (0..1, -1 — неизвестен) и строкой статуса. Повторный вызов с той же причиной обновляет прогресс и текст. В режимах с автопоказом ещё и показывает экран. Удержанием владеет вызвавший объект: если он уничтожен, удержание снимается (с предупреждением в логе).

static void SetLoadingScreenHold(FGameplayTag Reason, float Progress = -1.0f, const FText& StatusText = FText::GetEmpty())
Параметр Тип Направление По умолчанию Примечание
Reason FGameplayTag input — —
Progress float input -1 —
StatusText const FText& input пусто Расширенный пин

Расширенная настройка — StatusText

Releases a hold only when called by the object that set it. (перевод отсутствует)

static void ReleaseLoadingScreenHold(FGameplayTag Reason)
Параметр Тип Направление По умолчанию Примечание
Reason FGameplayTag input — —

Есть ли удержание с этой причиной.

static bool IsLoadingScreenHeld(FGameplayTag Reason)
Параметр Тип Направление По умолчанию Примечание
Reason FGameplayTag input — —
ReturnValue bool output — —

Все причины, которые держат экран сейчас, включая причины самого плагина (переезд, ассеты, шейдеры, игроки…).

static TArray<FSGCLoadingHold> GetLoadingScreenHolds()
Параметр Тип Направление По умолчанию Примечание
ReturnValue TArray&lt;FSGCLoadingHold&gt; output — —

Adds tips for SGC Loading Tip. Each tip is shown once per round, in a new order each round; the round continues after a game restart. A tip already in the list is not added twice. Selected Replace Common content sets hide these tips for their destination maps. (перевод отсутствует)

static void AddLoadingTips(const TArray<FText>& Tips)
Параметр Тип Направление По умолчанию Примечание
Tips const TArray&lt;FText&gt;&amp; input — —

Removes tips added by Add Loading Tips. Matching tips from content sets remain. A removed tip shown now is replaced at once. (перевод отсутствует)

static void RemoveLoadingTips(const TArray<FText>& Tips)
Параметр Тип Направление По умолчанию Примечание
Tips const TArray&lt;FText&gt;&amp; input — —

Removes all tips added by Add Loading Tips. Tips from content sets remain. (перевод отсутствует)

static void ClearLoadingTips()

Adds backgrounds for SGC Loading Background: an image and an optional text of its own. Images load in the background only while the loading screen shows them; one that fails to load is removed. Each background is shown once per round, in a new order each round; the round continues after a game restart. Selected Replace Common content sets hide these backgrounds for their destination maps. (перевод отсутствует)

static void AddLoadingBackgrounds(const TArray<FSGCLoadingBackground>& Backgrounds)
Параметр Тип Направление По умолчанию Примечание
Backgrounds const TArray&lt;FSGCLoadingBackground&gt;&amp; input — —

Removes backgrounds added by Add Loading Backgrounds. Matching backgrounds from content sets remain. A removed background shown now is replaced at once. (перевод отсутствует)

static void RemoveLoadingBackgrounds(const TArray<FSGCLoadingBackground>& Backgrounds)
Параметр Тип Направление По умолчанию Примечание
Backgrounds const TArray&lt;FSGCLoadingBackground&gt;&amp; input — —

Removes all backgrounds added by Add Loading Backgrounds. Backgrounds from content sets remain. (перевод отсутствует)

static void ClearLoadingBackgrounds()

Идёт ли сейчас предкомпиляция PSO (графические конвейеры под эту видеокарту и драйвер) и сколько осталось. Например, чтобы перед «Новой игрой» предупредить игрока, что первые минуты возможны подтормаживания.

static bool GetPSOPrecompileStatus(int32& Remaining)
Параметр Тип Направление По умолчанию Примечание
Remaining int32&amp; output — —
ReturnValue bool output — —

Показывает или скрывает оверлей метрик. Не записывает Project Settings.

static void SetMetricsOverlayEnabled(bool bEnabled)
Параметр Тип Направление По умолчанию Примечание
bEnabled bool input — —

Выбирает FPS, Memory или оба. Не записывает Project Settings.

static void SetMetricsOverlayMode(ESGCDebugOverlayMode Mode)
Параметр Тип Направление По умолчанию Примечание
Mode ESGCDebugOverlayMode input — —

Перемещает оверлей в угол экрана. Не записывает Project Settings.

static void SetMetricsOverlayCorner(ESGCDebugOverlayCorner Corner)
Параметр Тип Направление По умолчанию Примечание
Corner ESGCDebugOverlayCorner input — —

Задаёт цвет текста оверлея. Не записывает Project Settings.

static void SetMetricsOverlayColor(FLinearColor Color)
Параметр Тип Направление По умолчанию Примечание
Color FLinearColor input — —

Фон экрана загрузки. Картинка загружается в фоне, только когда она нужна экрану.

Имя в редакторе Описание Значение по умолчанию Ограничения
Image (перевод отсутствует)
Image
Картинка слайда. Лучше в группе текстур UI без мипов. Не задано —
Tip (перевод отсутствует)
Tip
Текст, который SGC Loading Tip покажет с этой картинкой. Пусто — следующая подсказка из Add Loading Tips. пусто —

How a selected map-specific set combines with common content. (перевод отсутствует)

Значение Описание
Add to Common (перевод отсутствует) Include common sets and content added through Add Loading Tips and Add Loading Backgrounds. (перевод отсутствует)
Replace Common (перевод отсутствует) Exclude common sets and content added through Add Loading Tips and Add Loading Backgrounds. (перевод отсутствует)

Одна причина, которая держит экран загрузки.

Имя в редакторе Описание Значение по умолчанию Ограничения
Reason (перевод отсутствует)
Reason
Причина удержания (LoadingScreen.Hold.*). Пустой тег Gameplay —
Progress (перевод отсутствует)
Progress
0..1 или отрицательное значение, если прогресс неизвестен. -1 —
Status Text (перевод отсутствует)
StatusText
Строка статуса этого удержания. Пусто — у удержания нет строки. пусто —
Held Secs (перевод отсутствует)
HeldSecs
Секунды с момента постановки удержания. 0 —

Когда экран загрузки показывается и закрывается.

Значение Описание
Auto Show, Manual Dismiss (перевод отсутствует) Показывается сам при переезде, seamless travel, подключении к серверу и удержаниях игры. Закрывается только Dismiss Loading Screen.
Automatic (перевод отсутствует) Показывается сам при переезде, seamless travel, подключении к серверу и удержаниях игры. Закрывается сам, когда удержаний не осталось.
Manual (перевод отсутствует) Показывается только Push Loading Screen. Закрывается только Dismiss Loading Screen.
Manual Show, Auto Dismiss (перевод отсутствует) Показывается только Push Loading Screen. Закрывается сам, когда удержаний не осталось.

Значение Описание
Top Left (перевод отсутствует) —
Top Right (перевод отсутствует) —
Bottom Left (перевод отсутствует) —
Bottom Right (перевод отсутствует) —

Значение Описание
FPS (перевод отсутствует) —
Memory (перевод отсутствует) —
FPS and Memory (перевод отсутствует) —

Current phase of the game-instance loading screen. (перевод отсутствует)

Значение Описание
Unavailable (перевод отсутствует) —
Idle (перевод отсутствует) —
Pending (перевод отсутствует) —
Visible (перевод отсутствует) —
Fading Out (перевод отсутствует) —

Origin of a loading screen request. (перевод отсутствует)

Значение Описание
None (перевод отсутствует) —
Manual (перевод отсутствует) —
Hold (перевод отсутствует) —
Map Travel (перевод отсутствует) —
Seamless Travel (перевод отсутствует) —
Client Travel (перевод отсутствует) —
Server Connection (перевод отсутствует) —

Final result of a loading screen request. Ready means loading completed, not merely that the screen was shown. (перевод отсутствует)

Значение Описание
Ready (перевод отсутствует) —
Cancelled (перевод отсутствует) —
Timed Out (перевод отсутствует) —
Show Failed (перевод отсутствует) —

Result of waiting for a screen to appear; Unavailable includes a dedicated server, which has no screen. (перевод отсутствует)

Значение Описание
Cancelled (перевод отсутствует) —
Show Failed (перевод отсутствует) —
Unavailable (перевод отсутствует) —

Immutable identity and origin of one loading screen request. (перевод отсутствует)

Имя в редакторе Описание Значение по умолчанию Ограничения
Request Id (перевод отсутствует)
RequestId
Identifies this request within its Game Instance. (перевод отсутствует) 0 —
Reason (перевод отсутствует)
Reason
What requested the loading screen. (перевод отсутствует) None (перевод отсутствует) —
Map Key (перевод отсутствует)
MapKey
Destination map path or name, or an empty string when no map is known. (перевод отсутствует) пусто —

Result paired with the request that produced it, including when a callback starts another request. (перевод отсутствует)

Имя в редакторе Описание Значение по умолчанию Ограничения
Context (перевод отсутствует)
Context
Identifies the request associated with this result, even if another screen has since been requested. (перевод отсутствует) RequestId 0, Reason None, пустой MapKey —
Outcome (перевод отсутствует)
Outcome
Whether loading completed, was cancelled, exceeded Max Visible Secs, or failed to show a screen. (перевод отсутствует) Cancelled (перевод отсутствует) —