C# Class TShockAPI.ConfigFile

Afficher le fichier Open project: NyxStudios/TShock Class Usage Examples

Méthodes publiques

Свойство Type Description
ConfigRead Action

Méthodes publiques

Méthode Description
DumpDescriptions ( ) : void

Dumps all configuration options to a text file in Markdown format

Read ( Stream stream ) : ConfigFile

Reads the configuration file from a stream

Read ( string path ) : ConfigFile

Reads a configuration file from a given path

Write ( Stream stream ) : void

Writes the configuration to a stream

Write ( string path ) : void

Writes the configuration to a given path

Method Details

DumpDescriptions() public static méthode

Dumps all configuration options to a text file in Markdown format
public static DumpDescriptions ( ) : void
Résultat void

Read() public static méthode

Reads the configuration file from a stream
public static Read ( Stream stream ) : ConfigFile
stream Stream stream
Résultat ConfigFile

Read() public static méthode

Reads a configuration file from a given path
public static Read ( string path ) : ConfigFile
path string string path
Résultat ConfigFile

Write() public méthode

Writes the configuration to a stream
public Write ( Stream stream ) : void
stream Stream stream
Résultat void

Write() public méthode

Writes the configuration to a given path
public Write ( string path ) : void
path string string path - Location to put the config file
Résultat void

Property Details

ConfigRead public_oe static_oe property

On config read hook
public static Action ConfigRead
Résultat Action