ChatPlexSDK-BS 1.0.1-v6.2.0
C++ ChatPlex BeatSaber SDK
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
CP_SDK::Config::JsonConfig Class Referenceabstract

Json config file. More...

#include <JsonConfig.hpp>

Inheritance diagram for CP_SDK::Config::JsonConfig:
Inheritance graph
[legend]

Public Member Functions

void Warmup ()
 Dummy method for warmup.
 
void Reset ()
 Reset config to default.
 
void Save ()
 Save config file.
 

Protected Member Functions

 JsonConfig ()
 Constructor.
 
virtual ~JsonConfig ()
 Destructor.
 
virtual void Reset_Impl ()=0
 Reset config to default.
 
virtual CP_SDK_JSON_SERIALIZE_DECL ()=0
 Read the document.
 
virtual CP_SDK_JSON_UNSERIALIZE_DECL ()=0
 Write the document.
 
virtual std::filesystem::path GetRelativePath ()=0
 Get relative config path.
 
virtual std::filesystem::path GetFullPath ()
 Get full config path.
 
virtual void OnInit (bool p_OnCreation)=0
 On config init.
 
void Init ()
 Init config.
 
void WriteFile (std::filesystem::path p_FullPath)
 Write file.
 

Detailed Description

Json config file.

Definition at line 31 of file JsonConfig.hpp.

Constructor & Destructor Documentation

◆ JsonConfig()

CP_SDK::Config::JsonConfig::JsonConfig ( )
protected

Constructor.

◆ ~JsonConfig()

virtual CP_SDK::Config::JsonConfig::~JsonConfig ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ CP_SDK_JSON_SERIALIZE_DECL()

virtual CP_SDK::Config::JsonConfig::CP_SDK_JSON_SERIALIZE_DECL ( )
protectedpure virtual

Read the document.

Parameters
p_DocumentSource

Implemented in CP_SDK::CPConfig.

◆ CP_SDK_JSON_UNSERIALIZE_DECL()

virtual CP_SDK::Config::JsonConfig::CP_SDK_JSON_UNSERIALIZE_DECL ( )
protectedpure virtual

Write the document.

Parameters
p_DocumentTarget

Implemented in CP_SDK::CPConfig.

◆ GetFullPath()

virtual std::filesystem::path CP_SDK::Config::JsonConfig::GetFullPath ( )
protectedvirtual

Get full config path.

◆ GetRelativePath()

virtual std::filesystem::path CP_SDK::Config::JsonConfig::GetRelativePath ( )
protectedpure virtual

Get relative config path.

Implemented in CP_SDK::CPConfig.

◆ Init()

void CP_SDK::Config::JsonConfig::Init ( )
protected

Init config.

◆ OnInit()

virtual void CP_SDK::Config::JsonConfig::OnInit ( bool  p_OnCreation)
protectedpure virtual

On config init.

Parameters
p_OnCreationOn creation

Implemented in CP_SDK::CPConfig.

◆ Reset()

void CP_SDK::Config::JsonConfig::Reset ( )

Reset config to default.

◆ Reset_Impl()

virtual void CP_SDK::Config::JsonConfig::Reset_Impl ( )
protectedpure virtual

Reset config to default.

Implemented in CP_SDK::CPConfig.

◆ Save()

void CP_SDK::Config::JsonConfig::Save ( )

Save config file.

◆ Warmup()

void CP_SDK::Config::JsonConfig::Warmup ( )

Dummy method for warmup.

◆ WriteFile()

void CP_SDK::Config::JsonConfig::WriteFile ( std::filesystem::path  p_FullPath)
protected

Write file.

Parameters
p_FullPathFile path

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