Operating System Simulator Plugin  3.5.1
Unreal Engine plugin that simulates an Operating System Environment
Loading...
Searching...
No Matches
UOperatingSystemVideoPlayerProgramData Class Reference

#include "OperatingSystemVideoPlayerProgramData.h"

Inheritance diagram for UOperatingSystemVideoPlayerProgramData:
[legend]
Collaboration diagram for UOperatingSystemVideoPlayerProgramData:
[legend]

Public Member Functions

 UOperatingSystemVideoPlayerProgramData ()
 
virtual void OnCreate () override
 
void OnOpenFile (UOperatingSystemFile *OpenedFile)
 This function is called when a file is opened in the video player program. This function checks if there is a blueprint implementation of the OnOpenFile event. If there is a blueprint implementation, it calls the K2_OnOpenFile event and passes the opened file object as a parameter.
 
void SetLoopVideo (const bool bNewLoop)
 
- Public Member Functions inherited from UOperatingSystemProgramData
 UOperatingSystemProgramData ()
 
- Public Member Functions inherited from UOperatingSystemDataObject
template<class T >
TGetParentObject () const
 
OPERATINGSYSTEMSIMULATOR_API void SetTickEnabled (const bool bEnable)
 
OPERATINGSYSTEMSIMULATOR_API bool IsTickEnabled () const
 

Protected Member Functions

void K2_OnOpenFile (UOperatingSystemFile *OpenedFile)
 
- Protected Member Functions inherited from UOperatingSystemDataObject
virtual OPERATINGSYSTEMSIMULATOR_API bool ShouldCreate () const
 
virtual OPERATINGSYSTEMSIMULATOR_API void Tick (const float &DeltaSeconds)
 The Tick method receives the time elapsed since the last frame update and performs any necessary updates or computations.
 
virtual OPERATINGSYSTEMSIMULATOR_API void OnValidate (FGenericError &OutError)
 This method is called to validate the data object.
 
void K2_OnCreate ()
 K2_OnCreate.
 
void K2_Tick (const float &DeltaSeconds)
 K2_Tick method is an event meant to be overridden in Blueprint subclasses of OperatingSystemDataObject. It allows subclasses to define custom behavior that should be executed every tick.
 
bool K2_ShouldCreate () const
 Indicates whether the operating system data object should be created.
 

Additional Inherited Members

- Static Public Member Functions inherited from UOperatingSystemDataObject
static OPERATINGSYSTEMSIMULATOR_API UOperatingSystemDataObjectCreateDataObj (UObject *OwningObject, const TSoftClassPtr< UOperatingSystemDataObject > &DataClassPtr)
 
template<class T >
static OPERATINGSYSTEMSIMULATOR_API T * CreateDataObj (UObject *OwningObject, TSoftClassPtr< UOperatingSystemDataObject > DataClassPtr)
 This method creates a new instance of a data object of type T.
 
- Protected Attributes inherited from UOperatingSystemProgramData
TWeakObjectPtr< UOperatingSystemBaseProgramParentProgram
 
- Protected Attributes inherited from UOperatingSystemDataObject
TWeakObjectPtr< UObject > ParentObject
 
uint8 bStartWithTickEnabled: 1
 

Detailed Description

UOperatingSystemVideoPlayerProgramData is an abstract class that represents the program data for a video player program in the operating system.

This class inherits from UOperatingSystemProgramData and provides additional functionality specific to video players.

Constructor & Destructor Documentation

◆ UOperatingSystemVideoPlayerProgramData()

UOperatingSystemVideoPlayerProgramData::UOperatingSystemVideoPlayerProgramData ( )
Here is the call graph for this function:

Member Function Documentation

◆ K2_OnOpenFile()

void UOperatingSystemVideoPlayerProgramData::K2_OnOpenFile ( UOperatingSystemFile * OpenedFile)
protected

Called when a file is opened in the video player program.

This function checks if there is a blueprint implementation of the OnOpenFile event. If there is a blueprint implementation, it calls the K2_OnOpenFile event and passes the opened file object as a parameter.

Parameters
OpenedFileA pointer to the UOperatingSystemFile object representing the opened file.
See also
UOperatingSystemVideoPlayerProgramData::K2_OnOpenFile
Here is the caller graph for this function:

◆ OnCreate()

void UOperatingSystemVideoPlayerProgramData::OnCreate ( )
overridevirtual

Called when the video player program data is created.

This function is responsible for initializing the video player program data. It is called when the program data is created and performs the following tasks:

  • Calls the OnCreate function of the base class UOperatingSystemProgramData to perform any necessary initialization.
  • Retrieves the video player settings from the parent program.
  • Checks if the retrieved video player settings are valid. If not, it logs a warning message.
See also
UOperatingSystemVideoPlayerSettings

Reimplemented from UOperatingSystemProgramData.

Here is the call graph for this function:

◆ OnOpenFile()

void UOperatingSystemVideoPlayerProgramData::OnOpenFile ( UOperatingSystemFile * OpenedFile)

This function is called when a file is opened in the video player program. This function checks if there is a blueprint implementation of the OnOpenFile event. If there is a blueprint implementation, it calls the K2_OnOpenFile event and passes the opened file object as a parameter.

Parameters
OpenedFileA pointer to the UOperatingSystemFile object representing the opened file.
See also
UOperatingSystemVideoPlayerProgramData::K2_OnOpenFile
Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetLoopVideo()

void UOperatingSystemVideoPlayerProgramData::SetLoopVideo ( const bool bNewLoop)

Set to loop or not the video playback.

Parameters
bNewLoopTrue to loop the video.
Here is the call graph for this function:

The documentation for this class was generated from the following files: