add doc/**/cameras.md & update cameras library
This commit is contained in:
@@ -0,0 +1,66 @@
|
||||
# *cameras* library
|
||||
|
||||
Cameras manipulation library.
|
||||
|
||||
## Main functions
|
||||
|
||||
```lua
|
||||
cameras.get(name: str) -> int
|
||||
```
|
||||
|
||||
Returns a camera by name.
|
||||
|
||||
## Camera methods
|
||||
|
||||
```lua
|
||||
-- accessing camera
|
||||
local cam = cameras.get("pack:camera-name")
|
||||
|
||||
-- returns camera index
|
||||
cam:get_index() -> int
|
||||
|
||||
-- returns camera name
|
||||
cam:get_name() -> str
|
||||
|
||||
-- returns camera position
|
||||
cam:get_pos() -> vec3
|
||||
-- sets camera position
|
||||
cam:set_pos(pos:vec3)
|
||||
|
||||
-- returns camera rotation
|
||||
cam:get_rot() -> mat4
|
||||
-- sets camera rotation
|
||||
cam:set_rot(rot:mat4)
|
||||
|
||||
-- returns camera zoom value
|
||||
cam:get_zoom() -> number
|
||||
-- sets camera zoom value
|
||||
cam:set_zoom(zoom: number)
|
||||
|
||||
-- returns angle of the camera's field of view in Y (degrees)
|
||||
cam:get_fov() -> number
|
||||
-- sets camera field of view angle in Y (degrees)
|
||||
cam:set_fov(fov: number)
|
||||
|
||||
-- returns true if the Y axis is flipped
|
||||
cam:is_flipped() -> bool
|
||||
-- reflects the Y axis when true
|
||||
cam:set_flipped(flipped: bool)
|
||||
|
||||
-- checks if perspective mode is enabled
|
||||
cam:is_perspective() -> bool
|
||||
-- turns on/off perspective mode
|
||||
cam:set_perspective(perspective: bool)
|
||||
|
||||
-- returns camera direction vector
|
||||
cam:get_front() -> vec3
|
||||
-- returns camera right vector
|
||||
cam:get_right() -> vec3
|
||||
-- returns camera up vector
|
||||
cam:get_up() -> vec3
|
||||
|
||||
-- makes camera look to a given point
|
||||
cam:look_at(point:vec3)
|
||||
```
|
||||
|
||||
Use player.set_camera to switch cameras.
|
||||
@@ -0,0 +1,66 @@
|
||||
# Библиотека *cameras*
|
||||
|
||||
Библиотека предназначена для работы с камерами.
|
||||
|
||||
## Основные функции
|
||||
|
||||
```lua
|
||||
cameras.get(name: str) -> int
|
||||
```
|
||||
|
||||
Возвращает камеру по имени.
|
||||
|
||||
## Методы камеры
|
||||
|
||||
```lua
|
||||
-- получаем камеру
|
||||
local cam = cameras.get("пак:имя-камеры")
|
||||
|
||||
-- возвращает индекс камеры
|
||||
cam:get_index() -> int
|
||||
|
||||
-- возвращает имя камеры
|
||||
cam:get_name() -> str
|
||||
|
||||
-- возвращает позицию камеры
|
||||
cam:get_pos() -> vec3
|
||||
-- устанавливает позицию камеры
|
||||
cam:set_pos(pos: vec3)
|
||||
|
||||
-- возращает вращение камеры
|
||||
cam:get_rot() -> mat4
|
||||
-- устанавливает вращение камеры
|
||||
cam:set_rot(rot: mat4)
|
||||
|
||||
-- возвращает значение приближения камеры
|
||||
cam:get_zoom() -> number
|
||||
-- устанавливает значение приближения камеры
|
||||
cam:set_zoom(zoom: number)
|
||||
|
||||
-- возвращает угол поля зрения камеры по Y (в градусах)
|
||||
cam:get_fov() -> number
|
||||
-- устанавливает угол поля зрения камеры по Y (в градусах)
|
||||
cam:set_fov(fov: number)
|
||||
|
||||
-- возвращает true если ось Y отражена
|
||||
cam:is_flipped() -> bool
|
||||
-- отражает ось Y при значении true
|
||||
cam:set_flipped(flipped: bool)
|
||||
|
||||
-- проверяет, включен ли режим перспективы
|
||||
cam:is_perspective() -> bool
|
||||
-- включает/выключает режим перспективы
|
||||
cam:set_perspective(perspective: bool)
|
||||
|
||||
-- возвращает вектор направления камеры
|
||||
cam:get_front() -> vec3
|
||||
-- возвращает вектор направления направо
|
||||
cam:get_right() -> vec3
|
||||
-- возвращает вектор направления вверх
|
||||
cam:get_up() -> vec3
|
||||
|
||||
-- направляет камеру на заданную точку
|
||||
cam:look_at(point: vec3)
|
||||
```
|
||||
|
||||
Переключение камеры возможно через функцию player.set_camera.
|
||||
Reference in New Issue
Block a user