voxelcore/doc/ru/scripting/builtins/libgfx-skeletons.md

2.8 KiB
Raw Permalink Blame History

Библиотека gfx.skeletons

Библиотека для работы с именованными скелетами, такими как 'hand', использующийся для управления, отображаемыми при виде от первого лица, рукой и переносимым предметом. Набор функций аналогичен компоненту skeleton у сущностей.

Первым аргументом в функции передаётся имя скелета.

-- Возвращает объектную обёртку над скелетом
local skeleton = gfx.skeletons.get(name: string)

-- Возвращает индекс кости по имени или nil
skeleton:index(name: string) -> int

-- Возвращает имя модели, назначенной на кость с указанным индексом
skeleton:get_model(index: int) -> string

-- Переназначает модель кости с указанным индексом
-- Сбрасывает до изначальной, если не указывать имя
skeleton:set_model(index: int, name: string)

-- Возвращает матрицу трансформации кости с указанным индексом
skeleton:get_matrix(index: int) -> mat4

-- Устанавливает матрицу трансформации кости с указанным индексом
skeleton:set_matrix(index: int, matrix: mat4)

-- Возвращает смещение кости с указанным индексом относительно родительской
-- (как задано в конфиге скелета)
skeleton:get_bone_offset(index: int) -> vec3

-- Возвращает текстуру по ключу (динамически назначаемые текстуры - '$имя')
skeleton:get_texture(key: string) -> string

-- Назначает текстуру по ключу
skeleton:set_texture(key: string, value: string)

-- Проверяет статус видимости кости по индексу 
-- или всего скелета, если индекс не указан
skeleton:is_visible([опционально] index: int) -> boolean

-- Устанавливает статус видимости кости по индексу
-- или всего скелета, если индекс не указан
skeleton:set_visible([опционально] index: int, status: boolean)

-- Возвращает цвет сущности
skeleton:get_color() -> vec4

-- Возвращает цвет кости
skeleton:get_color(index: int) -> vec4

-- Устанавливает цвет сущности
skeleton:set_color(color: vec4)

-- Устанавливает цвет кости
skeleton:set_color(color: vec4, index: int)