1 sharedlibrarycoredatabasemodels EFClient

RaidMax edited this page 2023-05-20 22:09:21 -05:00

Table of Contents

• EFClient Public class
• Diagram
• Members
• Properties
• Public properties
• Methods
• Protected methods
• Public methods
• Details
• Inheritance
• Nested types
• Enums
• Constructors
• EFClient
• Methods
• Finalize
• ToString
• Tell [1/2]
• Arguments
• Summary
• Tell [2/2]
• Arguments
• TellAsync
• Arguments
• Warn
• Arguments
• Summary
• WarnClear
• Arguments
• Summary
• Returns
• Report
• Arguments
• Summary
• Returns
• Flag
• Arguments
• Unflag
• Arguments
• Summary
• Returns
• Kick [1/2]
• Arguments
• Summary
• Kick [2/2]
• Arguments
• Summary
• TempBan
• Arguments
• Summary
• Ban
• Arguments
• Summary
• Unban
• Arguments
• Summary
• Returns
• SetLevel
• Arguments
• IsAbleToConnectSimple
• Summary
• OnDisconnect
• OnJoin
• Arguments
• CanConnect
• Arguments
• UpdateTeam
• Arguments
• Lock
• Unlock
• Equals
• Arguments
• GetHashCode
• Properties
• Name
• CleanedName
• IPAddress
• IPAddressString
• IsIngame
• LinkedAccounts
• ClientNumber
• Ping
• Warnings
• ConnectionTime
• ConnectionLength
• CurrentServer
• Score
• IsBot
• IsZombieClient
• XuidString
• GuidString
• State
• Team
• TeamName
• ClientPermission
• Tag
• TemporalClientNumber

EFClient Public class

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph SharedLibraryCore.Database.Models
  SharedLibraryCore.Database.Models.EFClient[[EFClient]]
  end
  subgraph Data.Models.Client
  Data.Models.Client.EFClient[[EFClient]]
  end
Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient

Members

Properties

Public properties

Type	Name	Methods
string	CleanedName	get
int	ClientNumber	get, set
ClientPermission	ClientPermission	get
int	ConnectionLength	get
DateTime	ConnectionTime	get, set
Server	CurrentServer	get, set
string	GuidString	get
Nullable<int>	IPAddress	get, set
string	IPAddressString	get
bool	IsBot	get
bool	IsIngame	get
bool	IsZombieClient	get
IDictionary<int, long>	LinkedAccounts	get, set
string	Name	get, set
int	Ping	get, set
int	Score	get, set
ClientState	State	get, set
string	Tag	get, set
TeamType	Team	get, set
string	TeamName	get, set
int	TemporalClientNumber	get
int	Warnings	get, set
string	XuidString	get

Methods

Protected methods

Returns	Name
void	Finalize()

Public methods

Returns	Name
GameEvent	Ban(string banReason, EFClient sender, bool isEvade) permanently ban a client
Task<bool>	CanConnect(Nullable<int> ipAddress, bool enableImplicitLinking)
bool	Equals(object obj)
GameEvent	Flag(string flagReason, EFClient sender, Nullable<TimeSpan> flagLength)
int	GetHashCode()
bool	IsAbleToConnectSimple() Handles any client related logic on connection
GameEvent	Kick(...) kick a client for the given reason
Task	Lock()
Task	OnDisconnect()
Task	OnJoin(Nullable<int> ipAddress, bool enableImplicitLinking)
GameEvent	Report(string reportReason, EFClient sender) report a client for a given reason
GameEvent	SetLevel(Permission newPermission, EFClient sender)
GameEvent	Tell(...) send a message directly to the connected client
Task	TellAsync(IEnumerable<string> messages, CancellationToken token)
GameEvent	TempBan(string tempbanReason, TimeSpan banLength, EFClient sender) temporarily ban a client for the given time span
string	ToString()
GameEvent	Unban(string unbanReason, EFClient sender) unban a client
GameEvent	Unflag(string unflagReason, EFClient sender) unflag a client for a given reason
void	Unlock()
void	UpdateTeam(string newTeam)
GameEvent	Warn(string warnReason, EFClient sender) warn a client with given reason
GameEvent	WarnClear(EFClient sender) clear all warnings for a client

Details

Inheritance

• EFClient

Nested types

Enums

• ClientState
• TeamType

Constructors

EFClient

Source code

public EFClient()

Methods

Finalize

Source code

protected override void Finalize()

ToString

Source code

public override string ToString()

Tell [1/2]

Source code

public GameEvent Tell(string message)

Arguments

Type	Name	Description
string	message	message content to send to client

Summary

send a message directly to the connected client

Tell [2/2]

Source code

public void Tell(IEnumerable<string> messages)

Arguments

Type	Name	Description
IEnumerable<string>	messages

TellAsync

Source code

public async Task TellAsync(IEnumerable<string> messages, CancellationToken token)

Arguments

Type	Name	Description
IEnumerable<string>	messages
CancellationToken	token

Warn

Source code

public GameEvent Warn(string warnReason, EFClient sender)

Arguments

Type	Name	Description
string	warnReason	reason for warn
EFClient	sender	client performing the warn

Summary

warn a client with given reason

WarnClear

Source code

public GameEvent WarnClear(EFClient sender)

Arguments

Type	Name	Description
EFClient	sender	client performing the warn clear

Summary

clear all warnings for a client

Returns

Report

Source code

public GameEvent Report(string reportReason, EFClient sender)

Arguments

Type	Name	Description
string	reportReason	reason for the report
EFClient	sender	client performing the report

Summary

report a client for a given reason

Returns

Flag

Source code

public GameEvent Flag(string flagReason, EFClient sender, Nullable<TimeSpan> flagLength)

Arguments

Type	Name	Description
string	flagReason
EFClient	sender
Nullable<TimeSpan>	flagLength

Unflag

Source code

public GameEvent Unflag(string unflagReason, EFClient sender)

Arguments

Type	Name	Description
string	unflagReason	reason to unflag a player for
EFClient	sender	client performing the unflag

Summary

unflag a client for a given reason

Returns

game event for the un flug

Kick [1/2]

Source code

public GameEvent Kick(string kickReason, EFClient sender)

Arguments

Type	Name	Description
string	kickReason	reason to kick for
EFClient	sender	client performing the kick

Summary

kick a client for the given reason

Kick [2/2]

Source code

public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPenalty)

Arguments

Type	Name	Description
string	kickReason	reason to kick for
EFClient	sender	client performing the kick
EFPenalty	originalPenalty	original client penalty

Summary

kick a client for the given reason

TempBan

Source code

public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient sender)

Arguments

Type	Name	Description
string	tempbanReason	reason for the temp ban
TimeSpan	banLength	how long the temp ban lasts
EFClient	sender	client performing the tempban

Summary

temporarily ban a client for the given time span

Ban

Source code

public GameEvent Ban(string banReason, EFClient sender, bool isEvade)

Arguments

Type	Name	Description
string	banReason	reason for the ban
EFClient	sender	client performing the ban
bool	isEvade	obsolete

Summary

permanently ban a client

Unban

Source code

public GameEvent Unban(string unbanReason, EFClient sender)

Arguments

Type	Name	Description
string	unbanReason	reason for the unban
EFClient	sender	client performing the unban

Summary

unban a client

Returns

SetLevel

Source code

public GameEvent SetLevel(Permission newPermission, EFClient sender)

Arguments

Type	Name	Description
Permission	newPermission
EFClient	sender

IsAbleToConnectSimple

Source code

public bool IsAbleToConnectSimple()

Summary

Handles any client related logic on connection

OnDisconnect

Source code

public async Task OnDisconnect()

OnJoin

Source code

public async Task OnJoin(Nullable<int> ipAddress, bool enableImplicitLinking)

Arguments

Type	Name	Description
Nullable<int>	ipAddress
bool	enableImplicitLinking

CanConnect

Source code

public async Task<bool> CanConnect(Nullable<int> ipAddress, bool enableImplicitLinking)

Arguments

Type	Name	Description
Nullable<int>	ipAddress
bool	enableImplicitLinking

UpdateTeam

Source code

public void UpdateTeam(string newTeam)

Arguments

Type	Name	Description
string	newTeam

Lock

Source code

public async Task Lock()

Unlock

Source code

public void Unlock()

Equals

Source code

public override bool Equals(object obj)

Arguments

Type	Name	Description
object	obj

GetHashCode

Source code

public override int GetHashCode()

Properties

Name

public virtual string Name { get; set; }

CleanedName

public string CleanedName { get; }

IPAddress

public virtual Nullable<int> IPAddress { get; set; }

IPAddressString

public string IPAddressString { get; }

IsIngame

public bool IsIngame { get; }

LinkedAccounts

public virtual IDictionary<int, long> LinkedAccounts { get; set; }

ClientNumber

public int ClientNumber { get; set; }

Ping

public int Ping { get; set; }

Warnings

public int Warnings { get; set; }

ConnectionTime

public DateTime ConnectionTime { get; set; }

ConnectionLength

public int ConnectionLength { get; }

CurrentServer

public Server CurrentServer { get; set; }

Score

public int Score { get; set; }

IsBot

public bool IsBot { get; }

IsZombieClient

public bool IsZombieClient { get; }

XuidString

public string XuidString { get; }

GuidString

public string GuidString { get; }

State

public ClientState State { get; set; }

Team

public TeamType Team { get; set; }

TeamName

public string TeamName { get; set; }

ClientPermission

public ClientPermission ClientPermission { get; }

Tag

public string Tag { get; set; }

TemporalClientNumber

public int TemporalClientNumber { get; }

Generated with ModularDoc

• Overview
• Getting Started
• FAQ
• Knowledge Base
• Features
  • Commands
  • Webfront
  • Game Interface
  • Permission Sets
  • Plugins
  • API
  • Searching
• Plugin Development
  • Examples
• Configuration
• Game Log Server