mirror of
https://github.com/jimathy/jim_bridge.git
synced 2026-08-18 14:26:03 +01:00
better documentation layout
- seperated the 2000+ lines in ReadMe.md into seperate files. - useful if things expand - better readability for users - more organised layout
This commit is contained in:
28
documentation/main_functions/cameras.md
Normal file
28
documentation/main_functions/cameras.md
Normal file
@@ -0,0 +1,28 @@
|
||||
### cameras.lua
|
||||
This module provides utilities for managing temporary in-game cameras, useful for cutscenes, cinematic views, or scripted perspectives.
|
||||
|
||||
- **createTempCam(ent, coords)**
|
||||
|
||||
- Creates a temporary camera at the specified coordinates or relative to an entity.
|
||||
- If `ent` is an entity, the camera position is calculated as an offset from the entity's position using `GetOffsetFromEntityInWorldCoords`.
|
||||
- If `ent` is a `vector3`, it is used directly as the camera's position.
|
||||
- **Example:**
|
||||
```lua
|
||||
local cam = createTempCam(PlayerPedId(), GetEntityCoords(PlayerPedId()) + vector3(0, 2.0, 1.0))
|
||||
```
|
||||
|
||||
- **startTempCam(cam)**
|
||||
|
||||
- Activates and renders the temporary camera.
|
||||
- **Example:**
|
||||
```lua
|
||||
startTempCam(cam)
|
||||
```
|
||||
|
||||
- **stopTempCam()**
|
||||
|
||||
- Deactivates and deletes all currently running custom camera, restoring normal view.
|
||||
- **Example:**
|
||||
```lua
|
||||
stopTempCam()
|
||||
```
|
||||
Reference in New Issue
Block a user