Class VerbSystem

Inheritance
System.Object
SharedVerbSystem
VerbSystem
Namespace: Content.Client.Verbs
Assembly: Content.Client.dll
Syntax
public sealed class VerbSystem : SharedVerbSystem

Fields

| Improve this Doc View Source

EntityMenuLookupSize

When a user right clicks somewhere, how large is the box we use to get entities for the context menu?

Declaration
public const float EntityMenuLookupSize = null
Field Value
Type Description
System.Single
| Improve this Doc View Source

OnVerbsResponse

Declaration
public Action<VerbsResponseEvent>? OnVerbsResponse
Field Value
Type Description
System.Nullable<Action<VerbsResponseEvent>>
| Improve this Doc View Source

Visibility

These flags determine what entities the user can see on the context menu.

Declaration
public MenuVisibility Visibility
Field Value
Type Description
MenuVisibility

Methods

| Improve this Doc View Source

ExecuteVerb(EntityUid, Verb)

Execute actions associated with the given verb.

Declaration
public void ExecuteVerb(EntityUid target, Verb verb)
Parameters
Type Name Description
EntityUid target
Verb verb
Remarks

Unless this is a client-exclusive verb, this will also tell the server to run the same verb.

| Improve this Doc View Source

GetVerbs(EntityUid, EntityUid, List<Type>, Boolean)

Ask the server to send back a list of server-side verbs, and for now return an incomplete list of verbs (only those defined locally).

Declaration
public SortedSet<Verb> GetVerbs(EntityUid target, EntityUid user, List<Type> verbTypes, bool force = false)
Parameters
Type Name Description
EntityUid target
EntityUid user
List<Type> verbTypes
System.Boolean force
Returns
Type Description
SortedSet<Verb>
| Improve this Doc View Source

GetVerbs(EntityUid, EntityUid, Type, Boolean)

Asks the server to send back a list of server-side verbs, for the given verb type.

Declaration
public SortedSet<Verb> GetVerbs(EntityUid target, EntityUid user, Type type, bool force = false)
Parameters
Type Name Description
EntityUid target
EntityUid user
Type type
System.Boolean force
Returns
Type Description
SortedSet<Verb>
| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
Overrides
| Improve this Doc View Source

TryGetEntityMenuEntities(MapCoordinates, out Nullable<List<EntityUid>>)

Get all of the entities in an area for displaying on the context menu.

Declaration
public bool TryGetEntityMenuEntities(MapCoordinates targetPos, out List<EntityUid>? result)
Parameters
Type Name Description
Robust.Shared.Map.MapCoordinates targetPos
System.Nullable<List<EntityUid>> result
Returns
Type Description
System.Boolean