M&B: Bannerlord 1.0.0
The horns sound, the ravens gather.
Loading...
Searching...
No Matches
TaleWorlds.MountAndBlade.VideoPlaybackState Class Reference

Inherits TaleWorlds.Core.GameState.

Public Member Functions

void SetStartingParameters (string videoPath, string audioPath, string subtitleFileBasePath, float frameRate=30.0f, bool canUserSkip=true)
 Set Video Player initialization parameters. More...
 
void SetOnVideoFinisedDelegate (Action onVideoFinised)
 Set the lambda that the screen state will call when the video ends. More...
 
void OnVideoFinished ()
 THIS SHOULDN'T BE CALLED BY ANYONE EXCEPT THE VIDEOVIEW More...
 
- Public Member Functions inherited from TaleWorlds.Core.GameState
bool RegisterListener (IGameStateListener listener)
 
bool UnregisterListener (IGameStateListener listener)
 
GetListenerOfType< T > ()
 
- Public Member Functions inherited from TaleWorlds.ObjectSystem.MBObjectBase
 MBObjectBase ()
 
 MBObjectBase (MBObjectBase other)
 
 MBObjectBase (string stringId)
 
void AfterInitialized ()
 
virtual void AfterRegister ()
 
virtual void Initialize ()
 
virtual void Deserialize (MBObjectManager objectManager, XmlNode node)
 
override int GetHashCode ()
 
virtual TextObject GetName ()
 
void PreAfterLoadInternal ()
 
void AfterLoadInternal ()
 
void OnRegistered ()
 
void OnUnregistered ()
 

Properties

string VideoPath [get]
 
string AudioPath [get]
 
float FrameRate [get]
 
string SubtitleFileBasePath [get]
 
bool CanUserSkip [get]
 
- Properties inherited from TaleWorlds.Core.GameState
GameState Predecessor [get]
 
bool IsActive [get]
 
IReadOnlyCollection< IGameStateListenerListeners [get]
 
GameStateManager GameStateManager [get]
 
virtual bool IsMusicMenuState [get]
 Whether or not if this state should be treated as a menu state for the music manager. More...
 
virtual bool IsMenuState [get]
 Whether or not if this state is a screen/menu state for GUI. More...
 
virtual bool IsMission [get]
 
bool Activated [get]
 
- Properties inherited from TaleWorlds.ObjectSystem.MBObjectBase
string StringId [get, set]
 
MBGUID Id [get, set]
 
bool IsInitialized [get]
 
bool IsReady [get, set]
 

Additional Inherited Members

- Public Attributes inherited from TaleWorlds.Core.GameState
int Level
 
- Static Public Attributes inherited from TaleWorlds.Core.GameState
static int NumberOfListenerActivations
 
- Protected Member Functions inherited from TaleWorlds.Core.GameState
 GameState ()
 
virtual void OnInitialize ()
 
virtual void OnFinalize ()
 
virtual void OnActivate ()
 
virtual void OnDeactivate ()
 
- Protected Member Functions inherited from TaleWorlds.ObjectSystem.MBObjectBase
virtual void OnBeforeLoad ()
 
virtual void PreAfterLoad ()
 
virtual void AfterLoad ()
 

Member Function Documentation

◆ SetStartingParameters()

void TaleWorlds.MountAndBlade.VideoPlaybackState.SetStartingParameters ( string  videoPath,
string  audioPath,
string  subtitleFileBasePath,
float  frameRate = 30.0f,
bool  canUserSkip = true 
)
Parameters
videoPathPath to the video file on the disk.
audioPathPath to the audio file of the video on the disk.
subtitleFileBasePathBASE Path to the subtitle file on the disk. "_{LANGUAGE_CODE} gets added to the end of the base path. Language code convention is ISO 639-1. Default is en. Has to be SRT type.</param> <param name="frameRate">Frame rate to play the file at.</param> <param name="canUserSkip">Can user skip video with keys.

◆ SetOnVideoFinisedDelegate()

void TaleWorlds.MountAndBlade.VideoPlaybackState.SetOnVideoFinisedDelegate ( Action  onVideoFinised)

◆ OnVideoFinished()

void TaleWorlds.MountAndBlade.VideoPlaybackState.OnVideoFinished ( )

Property Documentation

◆ VideoPath

string TaleWorlds.MountAndBlade.VideoPlaybackState.VideoPath
get

◆ AudioPath

string TaleWorlds.MountAndBlade.VideoPlaybackState.AudioPath
get

◆ FrameRate

float TaleWorlds.MountAndBlade.VideoPlaybackState.FrameRate
get

◆ SubtitleFileBasePath

string TaleWorlds.MountAndBlade.VideoPlaybackState.SubtitleFileBasePath
get

◆ CanUserSkip

bool TaleWorlds.MountAndBlade.VideoPlaybackState.CanUserSkip
get