Click or drag to resize
IMyTerminalAction Interface
v01.180.0 (Beta)

[This is preliminary documentation and is subject to change.]

This is an interface wrapper for terminal actions that appear on a toolbar. An instance of this interface is created via MyAPIGateway.TerminalControls.CreateAction. Once created, you may modify various fields to control how the action behaves.

Namespace: Sandbox.ModAPI.Interfaces.Terminal
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public interface IMyTerminalAction : ITerminalAction

The IMyTerminalAction type exposes the following members.

Methods
Properties
  NameDescription
Public propertyAction
This is the action taken when an action is performed.
Public propertyEnabled
Allows you to set if this action is enabled or disabled
Public propertyIcon
Allows you to set the Icon of this action. It's a link to an icon texture.
Public propertyId (Inherited from ITerminalAction.)
Public propertyInvalidToolbarTypes
Allows you to set which toolbar type this action is invalid for. Adding to this means this action may not be added to that toolbar type.
Public propertyName
Allows you to set the name of the Action
Public propertyValidForGroups
Allows you to set if this action is valid in groups
Public propertyWriter
This allows you to set the "Icon Text" of an action (the text that appears under the icon in the toolbar)
Top
See Also