IMyTerminalBlock

From Space Engineers Wiki
Revision as of 14:23, 19 February 2017 by Rsa97 (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Версия игры: 1.175
Пространство имён Sandbox.ModAPI.Ingame

public interface IMyTerminalBlock : IMyCubeBlock, IMyEntity
  Общий интерфейс блоков, отображаемых в терминале

Свойства:

string CustomName { get; }
  Название блока, заданное в терминале

string CustomNameWithFaction { get; }
  Название блока, заданное в терминале, с названием фракции, которой принадлежит блок

string DetailedInfo { get; }
  Детальная информация, отображаемая в информационном окне терминала

string CustomInfo { get; }
  Информация, которую могут добавлять моды, из программируемого блока не записывается

bool ShowOnHUD { get; }
  Отображается ли блок на дисплее

bool ShowInTerminal { get; set; }
  Отображается ли блок в терминале

bool ShowInToolbarConfig { get; set; }
  Отображается ли блок в конфигураторе тулбара

Методы:

bool HasLocalPlayerAccess()
  Есть ли доступ к управлению блоком у данного игрока

bool HasPlayerAccess(long playerId)
  Есть ли доступ к управлению блоком у игрока c идентификатором playerId

void GetActions(List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect = null)
  Возвращает в resultList список действий, доступных через Apply для данного блока. Необязательная функция bool collect(ITerminalAction action) определяет, включать действие в список или нет.

void SearchActionsOfName(string name, List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect = null)
  Возвращает в resultList список действий, доступных через Apply для данного блока, названия которых содержат подстроку name. Необязательная функция bool collect(ITerminalAction action) определяет, включать действие в список или нет.

ITerminalAction GetActionWithName(string name)
  Возвращает действие с названием name, доступное через Apply для данного блока или null, если такого действия нет.

ITerminalProperty GetProperty(string id)
  Возвращает свойство блока с идентификатором id или null, если такого свойства нет.

void GetProperties(List<ITerminalProperty> resultList, Func<ITerminalProperty, bool> collect = null)
  Возвращает в resultList список свойств данного блока. Необязательная функция bool collect(ITerminalProperty property) определяет, включать свойство в список или нет.

Свойства, доступные через GetValue<T> / SetValue<T> (TerminalPropertyExtensions):

Boolean ShowInTerminal
  Показывать или нет блок в терминале

Boolean ShowInToolbarConfig
  Показывать или нет блок в меню настройки быстрых кнопок

StringBuilder Name
  Название блока, заданное в терминале

Boolean ShowOnHUD
  Отображать или нет блок на дисплее