Class GuidebookSystem

This system handles the help-verb and interactions with various client-side entities that are embedded into guidebooks.

Inheritance

System.Object

GuidebookSystem

Namespace: Content.Client.Guidebook

Assembly: Content.Client.dll

Syntax

public sealed class GuidebookSystem : EntitySystem

Fields

GuideEmbedTag

Declaration

public const string GuideEmbedTag = null

Field Value

Type	Description
System.String

Methods

GetGuidebookUser()

Gets a user entity to use for verbs and examinations. If the player has no attached entity, this will use a dummy client-side entity so that users can still use the guidebook when not attached to anything (e.g., in the lobby)

Declaration

public EntityUid GetGuidebookUser()

Returns

Type	Description
EntityUid

Initialize()

Declaration

public override void Initialize()

Events

OnGuidebookOpen

Declaration

public event Action<List<string>, List<string>?, string?, bool, string?>? OnGuidebookOpen

Event Type

Type	Description
System.Nullable<Action<List<System.String>, System.Nullable<List<System.String>>, System.Nullable<System.String>, System.Boolean, System.Nullable<System.String>>>