C# Class Nexus.Client.MessagerClient

This class enables communication between different instance of the mod manager.

Only one instance of the client can be running per game mode. This class allows one instance of the mod manager to send messages to the running instance to process.

Inheritance: IMessager

Afficher le fichier Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Méthodes publiques

Méthode	Description
AddMod ( string p_strFilePath ) : void	Adds the specified mod to the mod manager.
BringToFront ( ) : void	Brings the currently running client to the front.
Dispose ( ) : void	Disposes of the object. This shuts down any open IPC channels.
GetMessager ( EnvironmentInfo p_eifEnvironmentInfo, IGameModeDescriptor p_gmdGameModeInfo ) : IMessager	Gets an instance of a Messager to use to talk to the running instance of the client.
Post ( ) : void	Used as a simple Power On Self Test method. This method can be called to ensure a Messager is alive.

Private Methods

Méthode	Description
MessagerClient ( IMessager p_msgMessager ) : System	A simple constructor that initializes the object with the given values.

Method Details

AddMod() public méthode

Adds the specified mod to the mod manager.

public AddMod ( string p_strFilePath ) : void
p_strFilePath	string	The path or URL of the mod to add to the mod manager.
Résultat	void

BringToFront() public méthode

Brings the currently running client to the front.

public BringToFront ( ) : void
Résultat	void

Dispose() public méthode

Disposes of the object.

This shuts down any open IPC channels.

public Dispose ( ) : void
Résultat	void

GetMessager() public static méthode

Gets an instance of a Messager to use to talk to the running instance of the client.

public static GetMessager ( EnvironmentInfo p_eifEnvironmentInfo, IGameModeDescriptor p_gmdGameModeInfo ) : IMessager
p_eifEnvironmentInfo	EnvironmentInfo	The application's envrionment info.
p_gmdGameModeInfo	IGameModeDescriptor	The descriptor of the game mode for which mods are being managed.
Résultat	IMessager

Post() public méthode

Used as a simple Power On Self Test method.

This method can be called to ensure a Messager is alive.

public Post ( ) : void
Résultat	void