Mod Helpers  v5.9.6
A centralized collection of library code, helpful services, and end-user functions for mod management and information.
HamstarHelpers.Services.Network.Client Class Reference

Supplies assorted server informations and tools. More...

Inheritance diagram for HamstarHelpers.Services.Network.Client:
HamstarHelpers.Classes.Loadable.ILoadable HamstarHelpers.Classes.Loadable.ILoadable HamstarHelpers.Classes.Loadable.ILoadable

Public Member Functions

delegate void TileSectionPacketSubscriber (int tileX, int tileY, int width, int height, BinaryReader data)
 

Static Public Member Functions

static bool StartBroadcastingMyCursorPosition ()
 Begins a broadcast loop (via. Timers) every 1/4 second to tell everyone where the current player's cursor is located. More...
 
static void StopBroadcastingMyCursorPosition ()
 Ends the current cursor position broadcast loop. More...
 
static void SubscribeToTileSectionPackets (TileSectionPacketSubscriber callback)
 Allows intercepting tile sections as they're received. More...
 

Static Public Attributes

static IReadOnlyDictionary< int,(short X, short Y)> LastKnownCursorPositions
 Shows last known positions of each player's mouse cursor. Must be activated via. StartBroadcastingMyCursorPosition(), first. More...
 

Detailed Description

Supplies assorted server informations and tools.

Definition at line 16 of file Client_Cursor.cs.

Member Function Documentation

◆ StartBroadcastingMyCursorPosition()

static bool HamstarHelpers.Services.Network.Client.StartBroadcastingMyCursorPosition ( )
static

Begins a broadcast loop (via. Timers) every 1/4 second to tell everyone where the current player's cursor is located.

Returns
true if loop not already running.

Definition at line 39 of file Client_Cursor.cs.

◆ StopBroadcastingMyCursorPosition()

static void HamstarHelpers.Services.Network.Client.StopBroadcastingMyCursorPosition ( )
static

Ends the current cursor position broadcast loop.

Definition at line 59 of file Client_Cursor.cs.

◆ SubscribeToTileSectionPackets()

static void HamstarHelpers.Services.Network.Client.SubscribeToTileSectionPackets ( TileSectionPacketSubscriber  callback)
static

Allows intercepting tile sections as they're received.

Parameters
callback

Definition at line 31 of file Client_HijackPacket.cs.

◆ TileSectionPacketSubscriber()

delegate void HamstarHelpers.Services.Network.Client.TileSectionPacketSubscriber ( int  tileX,
int  tileY,
int  width,
int  height,
BinaryReader  data 
)

Parameters
tileX
tileY
width
height
data

Member Data Documentation

◆ LastKnownCursorPositions

IReadOnlyDictionary<int, (short X, short Y)> HamstarHelpers.Services.Network.Client.LastKnownCursorPositions
static

Shows last known positions of each player's mouse cursor. Must be activated via. StartBroadcastingMyCursorPosition(), first.

Definition at line 20 of file Client_Cursor.cs.


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