ScriptObject¶
-
class
ScriptObject
(name=None, guid=None, parent=None, host_api=<module 'host' from '/home/docs/checkouts/readthedocs.org/user_builds/trassir-script-framework/checkouts/stable/tests/host/__init__.py'>)[исходный код]¶ Создает объект для генерации событий
Параметры: Примечание
- Имя объекта по умолчанию -
BaseUtils.get_script_name()
- Guid объекта по умолчанию строится по шаблноу
"{script_guid}_object"
- Guid родительского объекта по умолчанию -
BaseUtils.get_server_guid()
Examples
>>> # Создаем объект >>> scr_obj = ScriptObject()
>>> # Проверяем текущее состояние объекта >>> scr_obj.health 'OK'
>>> # Установить флаг возле объекта >>> scr_obj.check_me = True
>>> # Сгенерировать событие с текстом >>> scr_obj.fire_event_v2("New event")
-
health
¶ Состояние объекта
Type: "OK"
|"Error"
Добавляет кнопку в контекстное меню объекта
Параметры: - text (
str
) – Текст кнопки - callback (
function
) – Функция, которая вызывается при нажатии на кнопку. В качестве единственного аргумента функция приимает текущий объект (host.object(self.guid)
).
Результат: Хендлер контекстного меню
Тип результата: SE_ContextCatcher
Raises: ValueError
– Если пустой текст кнопки.TypeError
– Если callback нельзя вызвать в качестве функции.
Examples
>>> scr = ScriptObject() >>> >>> def switch(obj): ... check_me = scr.check_me ... scr.check_me = not check_me ... btn.set_name("ON" if check_me else "OFF") >>> >>> btn = scr.context_menu_button("ON", switch) >>> btn <host.SE_ContextCatcher object at 0x17B01A98> >>> scr.context_menu [('ON', 'switch', <host.SE_ContextCatcher object at 0x17B01A98>)]
- text (
-
fire_event_v2
(message, channel='', data='')[исходный код]¶ Создает событие в Trassir
Параметры:
- Имя объекта по умолчанию -