GE Lua Documentation

fadeFromBlack

Definition

-- @/lua/ge/extensions/ui/fadeScreen.lua:38

local function fadeFromBlack(fade, args)
  fade = fade or 1
  args = args or {}
  -- local params = {fadeIn = 0, pause = 0, fadeOut = fade} -- fade from black
  -- guihooks.trigger('ChangeState', {state = 'fadeScreen', params = params})
  guihooks.trigger("LoadingScreen", { active = false, custom = { fadeOut = fade } })

  if headless_mode then -- in headless mode, skip this as there's no UI
    extensions.hook("onScreenFadeState", 3)
  end

  if args.useGlobalAudioFade == nil or args.useGlobalAudioFade then
    SFXSystem.setGlobalParameter("g_FadeTimeMS", fade * 1000) -- fade is in seconds, convert to milliseconds
    SFXSystem.setGlobalParameter("g_GameLoading", 0)
  end
end

Callers

  else
    ui_fadeScreen.fadeFromBlack(self.pinIn.duration.value)
  end

        if state == 2 and next(cycleArgs) then -- only during full fade cycle
          fadeFromBlack(cycleArgs.fadeOut, cycleArgs.args)
          table.clear(cycleArgs)