Show / Hide Table of Contents

Class GuideEntityEmbed

Control for embedding an entity into a guidebook/document. This is effectively a sprite-view that supports examination, interactions, and captions.

Inheritance
System.Object
Robust.Client.UserInterface.Control
Robust.Client.UserInterface.Controls.Container
Robust.Client.UserInterface.Controls.BoxContainer
GuideEntityEmbed
Implements
IDocumentTag
Namespace: Content.Client.Guidebook.Controls
Assembly: Content.Client.dll
Syntax
public sealed class GuideEntityEmbed : BoxContainer, IDocumentTag

Constructors

| Improve this Doc View Source

GuideEntityEmbed()

Declaration
public GuideEntityEmbed()
| Improve this Doc View Source

GuideEntityEmbed(String, Boolean, Boolean)

Declaration
public GuideEntityEmbed(string proto, bool caption, bool interactive)
Parameters
Type Name Description
System.String proto
System.Boolean caption
System.Boolean interactive

Fields

| Improve this Doc View Source

Interactive

Declaration
public bool Interactive
Field Value
Type Description
System.Boolean

Properties

| Improve this Doc View Source

Scale

Declaration
public Vector2 Scale { get; set; }
Property Value
Type Description
Vector2
| Improve this Doc View Source

Sprite

Declaration
public SpriteComponent Sprite { get; }
Property Value
Type Description
Robust.Client.GameObjects.SpriteComponent

Methods

| Improve this Doc View Source

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides
Robust.Client.UserInterface.Control.Dispose(System.Boolean)
| Improve this Doc View Source

KeyBindDown(GUIBoundKeyEventArgs)

Declaration
protected override void KeyBindDown(GUIBoundKeyEventArgs args)
Parameters
Type Name Description
Robust.Client.UserInterface.GUIBoundKeyEventArgs args
Overrides
Robust.Client.UserInterface.Control.KeyBindDown(Robust.Client.UserInterface.GUIBoundKeyEventArgs)
| Improve this Doc View Source

TryParseTag(Dictionary<String, String>, out Control)

Declaration
public bool TryParseTag(Dictionary<string, string> args, out Control control)
Parameters
Type Name Description
Dictionary<System.String, System.String> args
Robust.Client.UserInterface.Control control
Returns
Type Description
System.Boolean

Implements

IDocumentTag

Extension Methods

ControlExtension.GetControlOfType<T>(Control)
ControlExtension.GetControlOfType<T>(Control, String)
ControlExtension.GetControlOfType<T>(Control, Boolean)
ControlExtension.GetControlOfType<T>(Control, String, Boolean)
ControlExtension.GetSearchableControls(Control, Boolean)
ControlExtension.ChildrenContainText(Control, String)
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾