From 13d3e6c5741ae7c3756abfc93f298feb2672ff3c Mon Sep 17 00:00:00 2001 From: Lucas7yoshi Date: Thu, 28 Apr 2022 10:38:26 -0400 Subject: [PATCH 1/4] Cleanup cutscene documentation mistakes --- CUTSCENE/GetCutsceneTotalDuration.md | 4 ++-- CUTSCENE/SetCutscenePedComponentVariationFromPed.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CUTSCENE/GetCutsceneTotalDuration.md b/CUTSCENE/GetCutsceneTotalDuration.md index b78979506..5b25d96c5 100644 --- a/CUTSCENE/GetCutsceneTotalDuration.md +++ b/CUTSCENE/GetCutsceneTotalDuration.md @@ -9,7 +9,7 @@ int GET_CUTSCENE_TOTAL_DURATION(); ``` Gets the total length of the cutscene irrespective of playback list in milliseconds -To account for sections, see [`_GET_CUTSCENE_END_TIME`](#_0x971D7B15BCDBEF99) +To account for sections, see [`GET_CUTSCENE_END_TIME`](#_0x971D7B15BCDBEF99) ## Return value -Cutscene total length in milliseconds \ No newline at end of file +Cutscene total length in milliseconds diff --git a/CUTSCENE/SetCutscenePedComponentVariationFromPed.md b/CUTSCENE/SetCutscenePedComponentVariationFromPed.md index cf817035d..79ce2d5aa 100644 --- a/CUTSCENE/SetCutscenePedComponentVariationFromPed.md +++ b/CUTSCENE/SetCutscenePedComponentVariationFromPed.md @@ -11,7 +11,7 @@ void SET_CUTSCENE_PED_COMPONENT_VARIATION_FROM_PED(char* cutsceneEntName, Ped pe Sets the components for a cutscene ped, this will take precendence over the cutscene's component overrides. This does not require the entity be registered. -See +See [`REGISTER_ENTITY_FOR_CUTSCENE`](#_0xE40C1C56DF95C2E8) for an example. ## Parameters * **cutsceneEntName**: cut file cHandle, i.e Michael, Lamar, Franklin, MP_1-MP_4 etc From 91f5d48c9483a45738166e802ffb5cfab675dc1b Mon Sep 17 00:00:00 2001 From: Lucas7yoshi Date: Thu, 5 May 2022 12:08:02 -0400 Subject: [PATCH 2/4] minor changes --- CUTSCENE/CanSetExitStateForCamera.md | 2 +- CUTSCENE/CanSetExitStateForRegisteredEntity.md | 2 +- CUTSCENE/GetCutsceneEndTime.md | 2 +- CUTSCENE/RequestCutscene.md | 2 +- CUTSCENE/SetCutscenePedComponentVariationFromPed.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CUTSCENE/CanSetExitStateForCamera.md b/CUTSCENE/CanSetExitStateForCamera.md index 91bd8a86d..f3d2a4666 100644 --- a/CUTSCENE/CanSetExitStateForCamera.md +++ b/CUTSCENE/CanSetExitStateForCamera.md @@ -12,6 +12,6 @@ Whether or not it is safe to run functions on the camera, as the camera is now no longer being used by the cutscene. ## Parameters -* **p0**: Mostly false +* **p0**: ## Return value diff --git a/CUTSCENE/CanSetExitStateForRegisteredEntity.md b/CUTSCENE/CanSetExitStateForRegisteredEntity.md index cba4a8722..808df04dc 100644 --- a/CUTSCENE/CanSetExitStateForRegisteredEntity.md +++ b/CUTSCENE/CanSetExitStateForRegisteredEntity.md @@ -13,7 +13,7 @@ Returns on frame after cutscene ends, so you cannot get is while using IsCutscen Whether it is safe to start doing scripted actions on the entity, like simulating walking out of a cutscene. ## Parameters -* **cutsceneEntName**: i.e Michael +* **cutsceneEntName**: Name of the entity cHandle in the cutscene * **modelHash**: Can be 0 ## Return value diff --git a/CUTSCENE/GetCutsceneEndTime.md b/CUTSCENE/GetCutsceneEndTime.md index 2bdb8680e..e19dcd68a 100644 --- a/CUTSCENE/GetCutsceneEndTime.md +++ b/CUTSCENE/GetCutsceneEndTime.md @@ -5,7 +5,7 @@ aliases: ['0x971D7B15BCDBEF99'] ## _GET_CUTSCENE_END_TIME ```c -// 0x011883f41211432a +// 0x971D7B15BCDBEF99 int _GET_CUTSCENE_END_TIME(); ``` diff --git a/CUTSCENE/RequestCutscene.md b/CUTSCENE/RequestCutscene.md index 74228e513..bd9cd8ace 100644 --- a/CUTSCENE/RequestCutscene.md +++ b/CUTSCENE/RequestCutscene.md @@ -9,6 +9,6 @@ void REQUEST_CUTSCENE(char* cutsceneName, int flags); ``` ## Parameters -* **cutsceneName**: Case insensitive +* **cutsceneName**: Case insensitive name of the .cut file * **flags**: Usually 8 diff --git a/CUTSCENE/SetCutscenePedComponentVariationFromPed.md b/CUTSCENE/SetCutscenePedComponentVariationFromPed.md index 79ce2d5aa..895011e4c 100644 --- a/CUTSCENE/SetCutscenePedComponentVariationFromPed.md +++ b/CUTSCENE/SetCutscenePedComponentVariationFromPed.md @@ -14,6 +14,6 @@ Sets the components for a cutscene ped, this will take precendence over the cuts See [`REGISTER_ENTITY_FOR_CUTSCENE`](#_0xE40C1C56DF95C2E8) for an example. ## Parameters -* **cutsceneEntName**: cut file cHandle, i.e Michael, Lamar, Franklin, MP_1-MP_4 etc +* **cutsceneEntName**: Cutscene file cHandle, i.e Michael, Lamar, Franklin, MP_1-MP_4 * **ped**: Ped to copy components from * **modelHash**: Not strictly neccasary, can be 0 From a0482408fba8436b956d68859dd939bc83cffb48 Mon Sep 17 00:00:00 2001 From: AvarianKnight Date: Wed, 18 Sep 2024 23:20:05 -0500 Subject: [PATCH 3/4] tweak: name 0x11883F41211432A --- CUTSCENE/N_0x011883f41211432a.md | 20 -------------------- CUTSCENE/SetCutsceneOriginAndOrientation.md | 21 +++++++++++++++++++++ 2 files changed, 21 insertions(+), 20 deletions(-) delete mode 100644 CUTSCENE/N_0x011883f41211432a.md create mode 100644 CUTSCENE/SetCutsceneOriginAndOrientation.md diff --git a/CUTSCENE/N_0x011883f41211432a.md b/CUTSCENE/N_0x011883f41211432a.md deleted file mode 100644 index d9b6ca549..000000000 --- a/CUTSCENE/N_0x011883f41211432a.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -ns: CUTSCENE ---- -## _0x011883F41211432A - -```c -// 0x011883F41211432A -void _0x011883F41211432A(float x1, float y1, float z1, float x2, float y2, float z2, int p6); -``` - - -## Parameters -* **x1**: -* **y1**: -* **z1**: -* **x2**: -* **y2**: -* **z2**: -* **p6**: - diff --git a/CUTSCENE/SetCutsceneOriginAndOrientation.md b/CUTSCENE/SetCutsceneOriginAndOrientation.md new file mode 100644 index 000000000..594f86652 --- /dev/null +++ b/CUTSCENE/SetCutsceneOriginAndOrientation.md @@ -0,0 +1,21 @@ +--- +ns: CUTSCENE +aliases: ["0x011883F41211432A"] +--- +## SET_CUTSCENE_ORIGIN_AND_ORIENTATION + +```c +// 0x011883F41211432A +void SET_CUTSCENE_ORIGIN_AND_ORIENTATION(float x1, float y1, float z1, float x2, float y2, float z2, int p6); +``` + + +## Parameters +* **x1**: +* **y1**: +* **z1**: +* **x2**: +* **y2**: +* **z2**: +* **p6**: + From 573ad81242b4d2c4a881cf8af5b8500d9d7e7e9a Mon Sep 17 00:00:00 2001 From: AvarianKnight Date: Wed, 18 Sep 2024 23:20:54 -0500 Subject: [PATCH 4/4] tweak: remove underscore prefix, this is the natives name --- CUTSCENE/GetCutsceneEndTime.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CUTSCENE/GetCutsceneEndTime.md b/CUTSCENE/GetCutsceneEndTime.md index e19dcd68a..eb908d8b4 100644 --- a/CUTSCENE/GetCutsceneEndTime.md +++ b/CUTSCENE/GetCutsceneEndTime.md @@ -1,12 +1,12 @@ --- ns: CUTSCENE -aliases: ['0x971D7B15BCDBEF99'] +aliases: ["0x971D7B15BCDBEF99", "_GET_CUTSCENE_END_TIME"] --- -## _GET_CUTSCENE_END_TIME +## GET_CUTSCENE_END_TIME ```c // 0x971D7B15BCDBEF99 -int _GET_CUTSCENE_END_TIME(); +int GET_CUTSCENE_END_TIME(); ``` Returns the time of the cutscene's end accounting for [`REQUEST_CUTSCENE_WITH_PLAYBACK_LIST`](#_0xC23DE0E91C30B58C)