PlayBink - Game

Revision as of 18:58, 4 December 2021 by Kernel Panic (talk | contribs) (→‎Notes)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Member of: Game Script

Plays the specified bink file.

SyntaxEdit

Function PlayBink(string asFileName, bool abInterruptible = false, bool abMuteAudio = true, bool abMuteMusic = true, \
  bool abLetterbox = true) native global

ParametersEdit

  • asFileName: The bink file to play
  • abInterruptible: Is the movie interruptable?
    • Default: False
  • abMuteAudio: Should the normal game audio be muted?
    • Default: True
  • abMuteMusic: Should the game music be muted?
    • Default: True
  • abLetterbox: Should the movie be letterboxed, if necessary?
    • Default: True

Return ValueEdit

None.

ExamplesEdit

; Play the cool movie
Game.PlayBink("CoolMovie.bik")


; Play the cool movie, but allow it to be interrupted
Game.PlayBink("CoolMovie.bik", true)

NotesEdit

When the movie is playing, the game (including Papyrus) is completely frozen, so use with care. It will not return until the movie is over, or the user has canceled the movie.

On platform ORBIS(PS4), this function is broken and crashes the game with a ASYNC failure.

See AlsoEdit