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

Jump to bottom

Update documentation on some health related natives. #1157

Merged
merged 2 commits into from
Aug 9, 2024
Merged

Update documentation on some health related natives. #1157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
732b2d8
Update documentation on some health related natives.
colistro123 Aug 8, 2024
f0224de
Cleanup wording
AvarianKnight Aug 9, 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
16 changes: 8 additions & 8 deletions ENTITY/SetEntityHealth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ ns: ENTITY
void SET_ENTITY_HEALTH(Entity entity, int health);
```

health >= 0
When setting health for a player ped, the game will clamp the health value to ensure it does not exceed the maximum health. This maximum health can be retrieved by calling [`GET_PED_MAX_HEALTH`](#_0x4700A416E8324EF3). It can also be modified by calling [`SET_PED_MAX_HEALTH`](#_0xF5F6378C4F3419D3).

male ped ~= 100 - 200
When setting the health for non-player peds or entities, the maximum health will be increased if the new health value exceeds the current maximum.

female ped ~= 0 - 100
Default health for male peds is `200`, for female peds it is `175`.

```
NativeDB Added Parameter 3: int p2
```

### Added parameters
* **inflictor**: The handle for the entity that caused the damage.

## Parameters
* **entity**:
* **health**:
* **entity**: The entity handle.
* **health**: The health we should set this entity to.

18 changes: 13 additions & 5 deletions PED/IsPedInjured.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,20 @@ ns: PED
BOOL IS_PED_INJURED(Ped ped);
```

```
Gets a value indicating whether this ped's health is below its injured threshold.
The default threshold is 100.
```
Indicates whether this ped's health is below its injured threshold.
The default threshold is 100, these are stored in the `pedhealth.meta` file located in `common:\data\`

### Below are some of the values

| InjuredHealthThreshold | Name |
|------------------------|-----------|
| 100.000000 | Strong |
| 100.000000 | Average |
| 100.000000 | Weak |


## Parameters
* **ped**:
* **ped**: The ped to check for injuries.

## Return value
Returns `true` if the ped is injured, `false` otherwise.
9 changes: 2 additions & 7 deletions PED/SetPedMaxHealth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ ns: PED
void SET_PED_MAX_HEALTH(Ped ped, int value);
```

```
sets the maximum health of a ped
I think it's never been used in any script
```

## Parameters
* **ped**:
* **value**:
* **ped**: The ped handle we're setting this for.
* **value**: The new max health.

Loading