Show / Hide Table of Contents

Class GameClient

Static class that handles calls to functions related to the client

Inheritance
Object
GameClient
Inherited Members
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()
Namespace: Slipe.Client.Game
Assembly: SlipeClient.dll
Syntax
public static class GameClient

Properties

| Improve this Doc View Source

Console

Declaration
public static MtaConsole Console { get; }
Property Value
Type Description
MtaConsole
| Improve this Doc View Source

Debug

Declaration
public static MtaDebug Debug { get; }
Property Value
Type Description
MtaDebug
| Improve this Doc View Source

Engine

Get the Engine object

Declaration
public static Engine Engine { get; }
Property Value
Type Description
Engine
| Improve this Doc View Source

GuiInputEnabled

Get and set if the input is focused on Gui elements

Declaration
public static bool GuiInputEnabled { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

InputMode

Get and set the input mode

Declaration
public static InputMode InputMode { get; set; }
Property Value
Type Description
InputMode
| Improve this Doc View Source

IsMainMenuActive

Get whether the user is in the main menu or not

Declaration
public static bool IsMainMenuActive { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsMtaWindowActive

Get if any system windows that take focus are active.

Declaration
public static bool IsMtaWindowActive { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsTransferBoxActive

Get if the download box is active

Declaration
public static bool IsTransferBoxActive { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsTrayNotificationEnabled

Get if the client allows tray notifications from MTA

Declaration
public static bool IsTrayNotificationEnabled { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsVoiceEnabled

Get if voice is currently enabled

Declaration
public static bool IsVoiceEnabled { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Localization

Get a string tuple representing the localization of this client. The first string is the short code, the second the full language name

Declaration
public static Tuple<string, string> Localization { get; }
Property Value
Type Description
Tuple<String, String>
| Improve this Doc View Source

TickCount

Get the amount of time that the system has been running in milliseconds.

Declaration
public static int TickCount { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Version

Get the current MTA version of this client

Declaration
public static SystemVersion Version { get; }
Property Value
Type Description
SystemVersion

Methods

| Improve this Doc View Source

CreateTrayNotification(String, TrayIconType, Boolean)

Create a windows tray notification

Declaration
public static void CreateTrayNotification(string text, TrayIconType trayIcon = TrayIconType.Default, bool useSound = true)
Parameters
Type Name Description
String text
TrayIconType trayIcon
Boolean useSound
| Improve this Doc View Source

SetClipboard(String)

Set the client's clipboard text

Declaration
public static bool SetClipboard(string text)
Parameters
Type Name Description
String text
Returns
Type Description
Boolean
| Improve this Doc View Source

SetWindowFlashing(Boolean, Int32)

Set the client's window flashing

Declaration
public static bool SetWindowFlashing(bool shouldFlash, int count = 10)
Parameters
Type Name Description
Boolean shouldFlash
Int32 count
Returns
Type Description
Boolean

Events

| Improve this Doc View Source

OnFileDownloadComplete

Declaration
public static event GameClient.OnFileDownloadCompleteHandler OnFileDownloadComplete
Event Type
Type Description
GameClient.OnFileDownloadCompleteHandler
| Improve this Doc View Source

OnMinimize

Declaration
public static event GameClient.OnMinimizeHandler OnMinimize
Event Type
Type Description
GameClient.OnMinimizeHandler
| Improve this Doc View Source

OnNetworkInteruption

Declaration
public static event GameClient.OnNetworkInteruptionBeginHandler OnNetworkInteruption
Event Type
Type Description
GameClient.OnNetworkInteruptionBeginHandler
| Improve this Doc View Source

OnRestore

Declaration
public static event GameClient.OnRestoreHandler OnRestore
Event Type
Type Description
GameClient.OnRestoreHandler
| Improve this Doc View Source

OnStart

Declaration
public static event GameClient.OnStartHandler OnStart
Event Type
Type Description
GameClient.OnStartHandler
| Improve this Doc View Source

OnStop

Declaration
public static event GameClient.OnStopHandler OnStop
Event Type
Type Description
GameClient.OnStopHandler
| Improve this Doc View Source

OnUpdate

Declaration
public static event GameClient.OnUpdateHandler OnUpdate
Event Type
Type Description
GameClient.OnUpdateHandler
  • Improve this Doc
  • View Source
Back to top Generated by DocFX