From 062b31164bbc5e536c57433dff4325a502288c58 Mon Sep 17 00:00:00 2001 From: sasha80 Date: Wed, 29 Nov 2023 11:01:56 +0300 Subject: [PATCH] =?UTF-8?q?=D0=92=20=D0=BF=D1=80=D0=BE=D1=86=D0=B5=D1=81?= =?UTF-8?q?=D1=81=D0=B5.=20=D0=94=D0=BE=D1=80=D0=B0=D0=B1=D0=BE=D1=82?= =?UTF-8?q?=D0=BA=D0=B0=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82?= =?UTF-8?q?=D0=B0=D1=86=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- addons/godot-logger/README.md | 2 +- scripts/signaller.gd | 21 +++++++++++---------- scripts/tools.gd | 12 +++++++----- scripts/yau07.gd | 18 +++++++++--------- table/table.gd | 32 ++++++++++++++++++++++---------- 5 files changed, 50 insertions(+), 35 deletions(-) diff --git a/addons/godot-logger/README.md b/addons/godot-logger/README.md index 0d6f598..416382e 100644 --- a/addons/godot-logger/README.md +++ b/addons/godot-logger/README.md @@ -33,7 +33,7 @@ Log.fatal(text) const CUSTOM = Log.MAX << 1 # Bitwise left shift the MAX value for a custom level. func _ready() -> void: - Log.add_level(CUSTOM, "Level Name") + Log.add_level(CUSTOM, "Level Name") ``` ## Calling the custom level: diff --git a/scripts/signaller.gd b/scripts/signaller.gd index 5f11b14..6a3c619 100644 --- a/scripts/signaller.gd +++ b/scripts/signaller.gd @@ -6,34 +6,35 @@ class_name Signaller extends Node ## Вызывается, когда оператор выбирает цель в таблице. -## [param threats] - Словарь. Ключ - идентификатор (номер) цели. Значение - цель [br] -## [param th] - Выбранная цель [br] +## [param threats] - Словарь. Ключ - идентификатор (номер) цели. Значение - цель.[br] +## [param th] - Выбранная цель.[br] signal threat_selected(threats: Dictionary, th) ## Вызывается, когда оператор снимает выбор цели. -## [param threats] - Словарь. Ключ - идентификатор (номер) цели. Значение - цель [br] -## [param th] - Ранее выбранная цель [br] +## [param threats] - Словарь. Ключ - идентификатор (номер) цели. Значение - цель.[br] +## [param th] - Ранее выбранная цель.[br] signal threat_unselected(threats: Dictionary, th) ## Вызывается, когда пользователь переключает режим окна программы полный экран - оконный -## [param id] - Идентификатор окна. Присваевается вручную +## [param id] - Идентификатор окна. Присваевается вручную. signal full_screen(id: int) ## Вызывается, когда пользователь выбирает цель -## [param bip] - Отметка цели на экране +## [param bip] - Отметка цели на экране. signal rto_threat_sel (bip: Control) ## Вызывается, когда пользователь выбирает помеху -## [param btn] - Нажатая кнопка помехи +## [param btn] - Нажатая кнопка помехи. signal interfer_init (btn: PanelContainer) ## Вызывается, когда выбраны цели для постановки помех -## [param btn] - Нажатая кнопка помехи, [param sel_threats] - список целей +## [param btn] - Нажатая кнопка помехи.[br] +## [param sel_threats] - Cписок целей. signal interfer_create (btn: PanelContainer, sel_threats: Array) @@ -50,6 +51,6 @@ signal zoom_changed(zoom: int) ## [param zoom] - Вновь установленный уровень детализации signal zoom_complete(zoom: int) -## Вызывается при изменении координат карты -## [param lan], [param lat] - Вновь установленные координаты +## Вызывается при изменении координат карты. +## [param lan], [param lat] - Вновь установленные координаты. signal map_coords_changed(zoom: int) diff --git a/scripts/tools.gd b/scripts/tools.gd index 5b266f0..70d9fdd 100644 --- a/scripts/tools.gd +++ b/scripts/tools.gd @@ -7,7 +7,7 @@ extends Node func round_to(v: float, a: float) -> float: return snappedf(v, -a if v < 0 else a) -## Возвращает true, если val число, false - если иначе +## Возвращает [b]true[/b], если [param val] число, [b]false[/b] - если иначе. func type_is_num(val) -> bool: return (typeof(val) == TYPE_INT) or (typeof(val) == typeof(0.0)) @@ -61,8 +61,9 @@ func is_array_ipaddr(val: Array): and (val[1] < 65536) -## Преобразует декартовые координаты в полярные. [param pos0] -## - координаты центра, [param pos] - координаты точки +## Преобразует декартовые координаты в полярные.[br] +## [param pos0] - координаты центра.[br] +## [param pos] - координаты точки.[br] func map_dec_to_rad(pos0: Vector2, pos: Vector2) -> Vector2: var x1: float = pos.x - pos0.x var y1: float = pos.y - pos0.y @@ -75,7 +76,7 @@ func map_range(val: float, a0: float, a1: float, b0: float, b1: float) -> float: return (((val - a0) * (b1 - b0)) / (a1 - a0)) + b0 -## Возвращает true, если точка внутри заданного полигона +## Возвращает [b]true[/b], если точка внутри заданного полигона func is_point_in_polygon(pos: Vector2, p: PackedVector2Array) -> bool: var sz: = p.size() assert(sz) @@ -89,7 +90,8 @@ func is_point_in_polygon(pos: Vector2, p: PackedVector2Array) -> bool: ## Записывает слово [param val] в элемент байтовго массива [param buf] -## расположенный по индексу [param index]. Младшее слово +## расположенный по индексу [param index] (младшее слово).[br] +## [i]Следует использовать встроенные в[/i] [b]PackedByteArray[/b] [i]методы вместо этой функции.[/i] func set_wordi(buf: PackedByteArray, index: int, val: int) -> void: buf[index] = val & 0xff buf[index + 1] = (val >> 8) & 0xff diff --git a/scripts/yau07.gd b/scripts/yau07.gd index b299b70..dc6ce4f 100644 --- a/scripts/yau07.gd +++ b/scripts/yau07.gd @@ -13,8 +13,8 @@ class YaU07: ## Коды выполняемых команд enum CmdCode { - READ_ISA = 0, ## Код команды "читать порт ISA" ячейки ЯУ-07 - WRITE_ISA = 1 ## Код команды "записать порт ISA" ячейки ЯУ-07 + READ_ISA = 0, ## Код команды "читать порт ISA" внешней шины ячейки ЯУ-07 + WRITE_ISA = 1 ## Код команды "записать порт ISA" внешней шины ячейки ЯУ-07 } ## Состояние автомата выполнения команды @@ -109,10 +109,10 @@ class YaU07: return true - ## Возвращает код команды ЯУ-07 - ## [param rx_data] - Принятые данные[br] - ## Возвращает [b]null[/b] - Если код команды не найден[br] - ## Возвращает [b]0...255[/b] - Код команды + ## Возвращает код команды ЯУ-07. + ## [param rx_data] - Принятые данные.[br] + ## Возвращает [b]null[/b] - Если код команды не найден.[br] + ## Возвращает [b]0...255[/b] - Код команды.[br] func get_cmd_code(rx_data: PackedByteArray): var rx_data_len = rx_data.size() @@ -150,9 +150,9 @@ class YaU07: ## Заполняет состояние прибора данными прочитанными из портов ЯУ-07 ## для команд "читать порты" или "записать порты"[br] - ## [param rx_data] - Принятые данные[br] - ## Возвращает [b]true[/b] - Данные обработаны успешно[br] - ## Возвращает [b]false[/b] - Данные не обработаны из за ошибки[br] + ## [param rx_data] - Принятые данные.[br] + ## Возвращает [b]true[/b] - Данные обработаны успешно.[br] + ## Возвращает [b]false[/b] - Данные не обработаны из за ошибки.[br] func parse(rx_data: PackedByteArray) -> bool: if not online: diff --git a/table/table.gd b/table/table.gd index b00ad44..32c6dc0 100644 --- a/table/table.gd +++ b/table/table.gd @@ -46,8 +46,8 @@ func defaultselector_color_proc(_i_row: int): return selector_color ## Закрепляет заголовок таблицы. -## [param scrl] - Прокрутка родитель таблицы. -## [param prnt] - Родитель прокрутки. +## [param scrl] - Прокрутка родитель таблицы.[br] +## [param prnt] - Родитель прокрутки.[br] func pin_header(scrl: ScrollContainer, prnt: Control): scrl.remove_child(header) prnt.add_child(header) @@ -96,8 +96,8 @@ func selector_down(): emit_signal('selected_changed', i_row) -## -func set_columns_alignments(alignments): +## Устанавливает выравнивание из массива [param alignments] для всех колонок. +func set_columns_alignments(alignments: Array): assert(columns == alignments.size()) var rows_count: = get_rows_count() for i_row in rows_count: @@ -121,24 +121,31 @@ func load_node_scene(file_name: String): func _ready(): ScnSelector = load(selector_type_file) ScnNode = load(node_type_file) - assert(ScnSelector) - assert(ScnNode) + assert(ScnSelector is PackedScene) + assert(ScnNode is PackedScene) -## Выравнивает по нижнему левому углу. Используется для выравнивания по заголовку +## Выравнивает по нижнему левому углу. Используется для выравнивания по заголовку. func align_to_left_bottompos(hdr: Control, gap: = Vector2(0, 0)): position.x = hdr.position.x + gap.x position.y = hdr.position.y + hdr.size.y + gap.y -## [param i_col] - Индекс колонки. [param i_row] - Индекс ряда. +## Устанавливает пользовательские данные для ячейки.[br] +## [param i_col] - Индекс колонки.[br] +## [param i_row] - Индекс ряда.[br] +## [param pname] - Имя пользовательских данных.[br] +## [param val] - Значение пользовательских данных.[br] func set_node_meta(i_col: int, i_row: int, pname: String, val) -> void: var key: = get_node_key(NODE_KEY_FORMAT, i_col, i_row) var node = nodes[key] node.set_meta(pname, val) -## [param i_col] - Индекс колонки. [param i_row] - Индекс ряда. +## Возвращает пользовательские данные для ячейки.[br] +## [param i_col] - Индекс колонки.[br] +## [param i_row] - Индекс ряда.[br] +## [param pname] - Имя пользовательских данных.[br] func get_node_meta(i_col: int, i_row: int, pname: String): var key: = get_node_key(NODE_KEY_FORMAT, i_col, i_row) var node = nodes[key] @@ -146,7 +153,12 @@ func get_node_meta(i_col: int, i_row: int, pname: String): return node.get_meta(pname) -## [param i_col] - Индекс колонки. [param i_row] - Индекс ряда. +## Устанавливает свойство ячейки.[br] +## [param i_col] - Индекс колонки.[br] +## [param i_row] - Индекс ряда.[br] +## [param pname] - Имя свойства.[br] +## [param val] - Значение свойства.[br] +## [i]Свойство[/i] [param pname] [i]ячейки должно существовать.[/i] func set_node_property(i_col: int, i_row: int, pname: String, val) -> void: var key: = get_node_key(NODE_KEY_FORMAT, i_col, i_row) var node = nodes[key]