Browse Source

fix documentation (#395)

Alexey Gulev 1 year ago
parent
commit
e72f9467aa

+ 1 - 1
docs/en/manuals/debugging-game-logic.md

@@ -31,7 +31,7 @@ msg.post("@render:", "draw_line", { start_point = start_p, end_point = end_p, co
 The visual debug messages adds data to the rendering pipeline and is drawn as part of the regular render pipeline.
 The visual debug messages adds data to the rendering pipeline and is drawn as part of the regular render pipeline.
 
 
 * `"draw_line"` adds data that is rendered with the `render.draw_debug3d()` function in the render script.
 * `"draw_line"` adds data that is rendered with the `render.draw_debug3d()` function in the render script.
-* `"draw_text"` is rendered with the "/builtins/fonts/system_font.font" that uses the "/builtins/fonts/system_font.material" material.
+* `"draw_text"` is rendered with the `/builtins/fonts/debug/always_on_top.font` that uses the `/builtins/fonts/debug/always_on_top_font.material` material.
 * `"draw_debug_text"` is the same as `"draw_text"`, but it's rendered in a custom color.
 * `"draw_debug_text"` is the same as `"draw_text"`, but it's rendered in a custom color.
 
 
 Note that you probably want to update this data every frame so posting the messages in the `update()` function is a good idea.
 Note that you probably want to update this data every frame so posting the messages in the `update()` function is a good idea.

+ 1 - 1
docs/en/manuals/render.md

@@ -365,7 +365,7 @@ msg.post("@render:", "draw_line", { start_point = p1, end_point = p2, color = co
 ```
 ```
 
 
 `"draw_text"`
 `"draw_text"`
-: Draw debug text. Use to print debug information. The text is drawn with the built-in "system_font" font. The system font has a material with tag "text" and is rendered with other text in the default render script.
+: Draw debug text. Use to print debug information. The text is drawn with the built-in `always_on_top.font` font. The system font has a material with tag `debug_text` and is rendered with other text in the default render script.
 
 
 ```lua
 ```lua
 -- draw a text message
 -- draw a text message

+ 1 - 1
docs/ko/manuals/render.md

@@ -175,6 +175,6 @@ msg.post("@render:", "draw_text", { text = "Hello world!", position = vmath.vect
 
 
 * draw_line 메세지를 통해 씬(scene)에 추가된 모든 선(line)들은 render.draw_debug3d() 호출에 의해 그려집니다.
 * draw_line 메세지를 통해 씬(scene)에 추가된 모든 선(line)들은 render.draw_debug3d() 호출에 의해 그려집니다.
 
 
-* draw_text 메세지를 통해 씬(scene)에 추가된 모든 텍스트(text)들은 내장된 "system_font"로 그려집니다. 시스템 폰트는 "text" 태그가 있는 메터리얼을 가지므로 위의 렌더 스크립트 내용중에서  "self.text_pred" predicate에 그려집니다.
+* draw_text 메세지를 통해 씬(scene)에 추가된 모든 텍스트(text)들은 내장된 `always_on_top.font` 로 그려집니다. 시스템 폰트는 "text" 태그가 있는 메터리얼을 가지므로 위의 렌더 스크립트 내용중에서  `debug_text` predicate에 그려집니다.
 
 
 > toggle_profile 메세지를 @system 소켓으로 보내서 접근 할 수 있는 비주얼 프로파일러(visual profiler)는 스크립트로 처리 가능한 렌더러와는 다른 파트이므로 당신의 렌더 스크립트와는 분리되어 그려집니다.
 > toggle_profile 메세지를 @system 소켓으로 보내서 접근 할 수 있는 비주얼 프로파일러(visual profiler)는 스크립트로 처리 가능한 렌더러와는 다른 파트이므로 당신의 렌더 스크립트와는 분리되어 그려집니다.

+ 1 - 1
docs/ru/manuals/debugging-game-logic.md

@@ -31,7 +31,7 @@ msg.post("@render:", "draw_line", { start_point = start_p, end_point = end_p, co
 Сообщения визуальной отладки добавляют данные в пайплайн рендеринга и отрисовываются как часть обычного рендер пайплайна.
 Сообщения визуальной отладки добавляют данные в пайплайн рендеринга и отрисовываются как часть обычного рендер пайплайна.
 
 
 * `"draw_line"` добавляет данные, которые выводятся с помощью функции `render.draw_debug3d()` в рендер-скрипте.
 * `"draw_line"` добавляет данные, которые выводятся с помощью функции `render.draw_debug3d()` в рендер-скрипте.
-* `"draw_text"` рендерится с помощью "/builtins/fonts/system_font.font", который использует материал "/builtins/fonts/system_font.material".
+* `"draw_text"` рендерится с помощью `/builtins/fonts/debug/always_on_top.font`, который использует материал `/builtins/fonts/debug/always_on_top_font.material`.
 * `"draw_debug_text"` это то же самое, что и `"draw_text"`, но отображается в пользовательском цвете.
 * `"draw_debug_text"` это то же самое, что и `"draw_text"`, но отображается в пользовательском цвете.
 
 
 Следует отметить, что, вероятно, потребуется обновлять эти данные каждый кадр, поэтому размещение сообщений в функции `update()` является хорошей идеей.
 Следует отметить, что, вероятно, потребуется обновлять эти данные каждый кадр, поэтому размещение сообщений в функции `update()` является хорошей идеей.

+ 1 - 1
docs/ru/manuals/render.md

@@ -287,7 +287,7 @@ local MSG_SET_VIEW_PROJ =       hash("set_view_projection")
   ```
   ```
 
 
 `"draw_text"`
 `"draw_text"`
-: Отрисовать отладочный текст. Используется для печати отладочной информации. Текст отрисовывается встроенным шрифтом "system_font". Системный шрифт имеет материал с тегом "text" и рендерится с другим текстом в рендер скрипте по-умолчанию.
+: Отрисовать отладочный текст. Используется для печати отладочной информации. Текст отрисовывается встроенным шрифтом `always_on_top.font`. Системный шрифт имеет материал с тегом `debug_text` и рендерится с другим текстом в рендер скрипте по-умолчанию.
 
 
   ```lua
   ```lua
   -- отрисовать текстовое сообщение
   -- отрисовать текстовое сообщение

+ 1 - 1
docs/zh/manuals/debugging-game-logic.md

@@ -31,7 +31,7 @@ msg.post("@render:", "draw_line", { start_point = start_p, end_point = end_p, co
 调试绘制与普通的渲染处于同一个渲染管线之上.
 调试绘制与普通的渲染处于同一个渲染管线之上.
 
 
 * `"draw_line"` 实际是是使用渲染脚本的 `render.draw_debug3d()` 函数进行绘制的.
 * `"draw_line"` 实际是是使用渲染脚本的 `render.draw_debug3d()` 函数进行绘制的.
-* `"draw_text"` 使用的是 "/builtins/fonts/system_font.font" 字体和 "/builtins/fonts/system_font.material" 材质.
+* `"draw_text"` 使用的是 `/builtins/fonts/debug/always_on_top.font` 字体和 `/builtins/fonts/debug/always_on_top_font.material` 材质.
 * `"draw_debug_text"` 与 `"draw_text"` 类似, 只是可以自定义文字颜色.
 * `"draw_debug_text"` 与 `"draw_text"` 类似, 只是可以自定义文字颜色.
 
 
 注意一般调试信息都需要实时更新所以把它们放在 `update()` 函数中是个好主意.
 注意一般调试信息都需要实时更新所以把它们放在 `update()` 函数中是个好主意.

+ 1 - 1
docs/zh/manuals/render.md

@@ -364,7 +364,7 @@ msg.post("@render:", "draw_line", { start_point = p1, end_point = p2, color = co
 ```
 ```
 
 
 `"draw_text"`
 `"draw_text"`
-: 调试用文字绘制. 可以用来展示一些调试信息. 文字使用自带 "system_font" 字体. 使用材质标签 "text" 于渲染脚本里进行绘制.
+: 调试用文字绘制. 可以用来展示一些调试信息. 文字使用自带 "always_on_top.font" 字体. 使用材质标签 "debug_text" 于渲染脚本里进行绘制.
 
 
 ```lua
 ```lua
 -- 文字信息绘制
 -- 文字信息绘制