Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up cutscene doc mess ups #749

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+32 −31
Open

Clean up cutscene doc mess ups #749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
13d3e6c
Cleanup cutscene documentation mistakes
Lucas7yoshi Apr 28, 2022
91f5d48
minor changes
Lucas7yoshi May 5, 2022
a048240
tweak: name 0x11883F41211432A
AvarianKnight Sep 19, 2024
573ad81
tweak: remove underscore prefix, this is the natives name
AvarianKnight Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CUTSCENE/CanSetExitStateForCamera.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion CUTSCENE/CanSetExitStateForRegisteredEntity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions CUTSCENE/GetCutsceneEndTime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
ns: CUTSCENE
aliases: ['0x971D7B15BCDBEF99']
aliases: ["0x971D7B15BCDBEF99", "_GET_CUTSCENE_END_TIME"]
---
## _GET_CUTSCENE_END_TIME
## GET_CUTSCENE_END_TIME

```c
// 0x011883f41211432a
int _GET_CUTSCENE_END_TIME();
// 0x971D7B15BCDBEF99
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this will work properly, this might break stuff. @blattersturm could you verify this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what my actions were prior when I first made the mistake so that change was based on Gottfried's response

Copy link
Collaborator

@AvarianKnight AvarianKnight Aug 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that this is already "broken" with the way it currently because it will always return 0 due to sanitation, swapping this shouldn't break compatibility with anything.

This also didn't manage to overwrite the original native definition with an int return type so it shouldn't break C# codegen, we would just have to make sure that the native that was supposed to be in the enum slot gets named.

image

int GET_CUTSCENE_END_TIME();
```

Returns the time of the cutscene's end accounting for [`REQUEST_CUTSCENE_WITH_PLAYBACK_LIST`](#_0xC23DE0E91C30B58C)
Expand Down
4 changes: 2 additions & 2 deletions CUTSCENE/GetCutsceneTotalDuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Cutscene total length in milliseconds
20 changes: 0 additions & 20 deletions CUTSCENE/N_0x011883f41211432a.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion CUTSCENE/RequestCutscene.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

21 changes: 21 additions & 0 deletions CUTSCENE/SetCutsceneOriginAndOrientation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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**:

4 changes: 2 additions & 2 deletions CUTSCENE/SetCutscenePedComponentVariationFromPed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ 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
* **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
Loading