C# 클래스 Nexus.Client.ModManagement.ReadMeManager

파일 보기 프로젝트 열기: NexusMods/NexusModManager-4.5 1 사용 예제들

공개 메소드들

메소드 설명
CheckModReadMe ( string p_strModName ) : string[]

Check if there's a readme file for the given mod.

CheckReadMeFolder ( ) : bool

Checks if the read me folder is already present, otherwise it tries to create it.

DeleteReadMe ( string p_strFileName ) : void

Deletes the readme file.

GetModReadMe ( string p_strModName, string p_strFileName ) : string

Get the ReadMe file path if it exists.

LoadReadMe ( ) : void

Check if the readme setup file is already present.

ReadMeManager ( string p_strFilePath ) : System

A simple constructor that initializes the ReadMeManager.

ReadVersion ( string p_strReadMePath ) : System.Version

Reads the ReadMe manager version from the given file.

SaveReadMeConfig ( ) : void

Save the data to the category file.

VerifyReadMeFile ( TxFileManager p_tfmFileManager, string p_strArchivePath ) : bool

Verifies if the readme file exists in the archive and saves it to the ReadMe folder.

보호된 메소드들

메소드 설명
CreateReadMeArchive ( string p_strArchiveFile, string p_strFilesToCompress ) : bool

Creates the readme files archive for the current mod.

PurgeTempFolder ( ) : void

Removes any file in the ReadMe/Temp folder.

비공개 메소드들

메소드 설명
GetFileList ( Archive p_arcArchive, bool p_booRecurse ) : List

Retrieves the list of all files in the specified folder.

메소드 상세

CheckModReadMe() 공개 메소드

Check if there's a readme file for the given mod.
public CheckModReadMe ( string p_strModName ) : string[]
p_strModName string
리턴 string[]

CheckReadMeFolder() 공개 메소드

Checks if the read me folder is already present, otherwise it tries to create it.
public CheckReadMeFolder ( ) : bool
리턴 bool

CreateReadMeArchive() 보호된 메소드

Creates the readme files archive for the current mod.
protected CreateReadMeArchive ( string p_strArchiveFile, string p_strFilesToCompress ) : bool
p_strArchiveFile string The archive name.
p_strFilesToCompress string The list of files to compress.
리턴 bool

DeleteReadMe() 공개 메소드

Deletes the readme file.
public DeleteReadMe ( string p_strFileName ) : void
p_strFileName string The path where the ReadMe folder should be created.
리턴 void

GetModReadMe() 공개 메소드

Get the ReadMe file path if it exists.
public GetModReadMe ( string p_strModName, string p_strFileName ) : string
p_strModName string
p_strFileName string The mod file name.
리턴 string

LoadReadMe() 공개 메소드

Check if the readme setup file is already present.
public LoadReadMe ( ) : void
리턴 void

PurgeTempFolder() 보호된 메소드

Removes any file in the ReadMe/Temp folder.
protected PurgeTempFolder ( ) : void
리턴 void

ReadMeManager() 공개 메소드

A simple constructor that initializes the ReadMeManager.
public ReadMeManager ( string p_strFilePath ) : System
p_strFilePath string The path where the ReadMe folder should be created.
리턴 System

ReadVersion() 공개 정적인 메소드

Reads the ReadMe manager version from the given file.
public static ReadVersion ( string p_strReadMePath ) : System.Version
p_strReadMePath string
리턴 System.Version

SaveReadMeConfig() 공개 메소드

Save the data to the category file.
public SaveReadMeConfig ( ) : void
리턴 void

VerifyReadMeFile() 공개 메소드

Verifies if the readme file exists in the archive and saves it to the ReadMe folder.
public VerifyReadMeFile ( TxFileManager p_tfmFileManager, string p_strArchivePath ) : bool
p_tfmFileManager ChinhDo.Transactions.TxFileManager
p_strArchivePath string The path to the mod archive.
리턴 bool