Class DeathLinkService
- Namespace
- Archipelago.MultiClient.Net.BounceFeatures.DeathLink
- Assembly
- Archipelago.MultiClient.Net.dll
public class DeathLinkService
- Inheritance
-
DeathLinkService
- Inherited Members
Methods
DisableDeathLink()
Removes the "DeathLink" tag from your ArchipelagoSession and opts out of further OnDeathLinkReceived events
public void DisableDeathLink()
EnableDeathLink()
Adds "DeathLink" to your ArchipelagoSession's tags and opts you in to receiving OnDeathLinkReceived events
public void EnableDeathLink()
SendDeathLink(DeathLink)
Formats and sends a Bounce packet using the provided deathLink
object.
public void SendDeathLink(DeathLink deathLink)
Parameters
deathLink
DeathLinkDeathLink object containing the information of the death which occurred. Must at least contain the Source.
Exceptions
- ArchipelagoSocketClosedException
The websocket connection is not alive
Events
OnDeathLinkReceived
Delegate event that supplies the created DeathLink whenever one is received from the server as a bounce packet.
public event DeathLinkService.DeathLinkReceivedHandler OnDeathLinkReceived