1 sharedlibrarycore GameEvent

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

Table of Contents

• GameEvent Public class
• Diagram
• Members
• Properties
• Public properties
• Methods
• Protected methods
• Public methods
• Details
• Inheritance
• Nested types
• Enums
• Constructors
• GameEvent
• Methods
• Finalize
• Complete
• WaitAsync [1/2]
• WaitAsync [2/2]
• Arguments
• Summary
• Returns
• Properties
• TypeName
• Subtype
• Summary
• RequiredEntity
• GameTime
• Summary
• ImpersonationOrigin
• IsRemote
• Extra
• Time
• IncrementalId
• FailReason
• Failed
• Output
• IsBlocking
• Summary

GameEvent Public class

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph SharedLibraryCore
  SharedLibraryCore.GameEvent[[GameEvent]]
  end
  subgraph SharedLibraryCore.Events
  SharedLibraryCore.Events.CoreEvent[[CoreEvent]]
  class SharedLibraryCore.Events.CoreEvent abstractStyle;
  end
SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent

Members

Properties

Public properties

Type	Name	Methods
object	Extra	get, set
EventFailReason	FailReason	get, set
bool	Failed	get
Nullable<long>	GameTime Specifies the game time offset as printed in the log	get, set
EFClient	ImpersonationOrigin	get, set
long	IncrementalId	get
bool	IsBlocking Indicates if the event should block until it is complete	get, set
bool	IsRemote	get, set
List<string>	Output	get, set
EventRequiredEntity	RequiredEntity	get, set
string	Subtype suptype of the event for more detailed classification	get, set
DateTime	Time	get, set
string	TypeName	get

Methods

Protected methods

Returns	Name
void	Finalize()

Public methods

Returns	Name
void	Complete()
Task<GameEvent>	WaitAsync(...)

Details

Inheritance

• CoreEvent

Nested types

Enums

• EventFailReason
• EventRequiredEntity
• EventSource
• EventType

Constructors

GameEvent

Source code

public GameEvent()

Methods

Finalize

Source code

protected override void Finalize()

Complete

Source code

public void Complete()

WaitAsync [1/2]

Source code

public async Task<GameEvent> WaitAsync()

WaitAsync [2/2]

Source code

public async Task<GameEvent> WaitAsync(TimeSpan timeSpan, CancellationToken token)

Arguments

Type	Name	Description
TimeSpan	timeSpan
CancellationToken	token

Summary

asynchronously wait for GameEvent to be processed

Returns

waitable task

Properties

TypeName

public string TypeName { get; }

Subtype

public string Subtype { get; set; }

Summary

suptype of the event for more detailed classification

RequiredEntity

public EventRequiredEntity RequiredEntity { get; set; }

GameTime

public Nullable<long> GameTime { get; set; }

Summary

Specifies the game time offset as printed in the log

ImpersonationOrigin

public EFClient ImpersonationOrigin { get; set; }

IsRemote

public bool IsRemote { get; set; }

Extra

public object Extra { get; set; }

Time

public DateTime Time { get; set; }

IncrementalId

public long IncrementalId { get; }

FailReason

public EventFailReason FailReason { get; set; }

Failed

public bool Failed { get; }

Output

public List<string> Output { get; set; }

IsBlocking

public bool IsBlocking { get; set; }

Summary

Indicates if the event should block until it is complete

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