Skip to content

Commit

Permalink
Merge branch 'master' into force
Browse files Browse the repository at this point in the history
  • Loading branch information
coalaura authored Oct 11, 2024
2 parents aa40cc3 + 9690545 commit 1b2a4fd
Show file tree
Hide file tree
Showing 63 changed files with 1,469 additions and 1,047 deletions.
12 changes: 6 additions & 6 deletions AUDIO/PlayAnimalVocalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ void PLAY_ANIMAL_VOCALIZATION(Ped pedHandle, int animalType, char* speechName);
```c
enum eAudAnimalType {
AUD_ANIMAL_NONE = -1,
AUD_ANIMAL_BOAR,
AUD_ANIMAL_CHICKEN,
AUD_ANIMAL_DOG,
AUD_ANIMAL_DOG_ROTTWEILER,
AUD_ANIMAL_HORSE,
AUD_NUM_ANIMALS
AUD_ANIMAL_BOAR = 0,
AUD_ANIMAL_CHICKEN = 1,
AUD_ANIMAL_DOG = 2,
AUD_ANIMAL_DOG_ROTTWEILER = 3,
AUD_ANIMAL_HORSE = 4,
AUD_NUM_ANIMALS = 5
}
```

Expand Down
8 changes: 4 additions & 4 deletions AUDIO/SetAnimalMood.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ void SET_ANIMAL_MOOD(Ped animal, int mood);
```c
enum eAudAnimalMood {
AUD_ANIMAL_MOOD_ANGRY,
AUD_ANIMAL_MOOD_PLAYFUL,
AUD_ANIMAL_MOOD_ANGRY = 0,
AUD_ANIMAL_MOOD_PLAYFUL = 1,
AUD_ANIMAL_MOOD_NUM_MOODS
AUD_ANIMAL_MOOD_NUM_MOODS = 2
}
```


## Parameters
* **animal**:
* **mood**: Refer to eAudAnimalMood
* **mood**: Refer to `eAudAnimalMood`

2 changes: 1 addition & 1 deletion AUDIO/SetAudioSpecialEffectMode.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ void SET_AUDIO_SPECIAL_EFFECT_MODE(int mode);
Needs to be called every frame.
```c
enum audSpecialEffectMode
enum eAudSpecialEffectMode
{
kSpecialEffectModeNormal = 0,
kSpecialEffectModeUnderwater = 1,
Expand Down
2 changes: 1 addition & 1 deletion CAM/GetCamActiveViewModeContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ int _GET_CAM_ACTIVE_VIEW_MODE_CONTEXT();
Enumerated type defined in camControlHelperMetadataViewModes:

```c
enum Context {
enum eContext {
ON_FOOT = 0, // [G|S]ET_FOLLOW_PED_CAM_*
IN_VEHICLE = 1, // [G|S]ET_FOLLOW_VEHICLE_CAM_*
ON_BIKE = 2,
Expand Down
2 changes: 1 addition & 1 deletion CAM/GetFollowPedCamViewMode.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ int GET_FOLLOW_PED_CAM_VIEW_MODE();

```c
// view mode enumeration
enum _0xA11D7CA8
enum eCamViewMode
{
THIRD_PERSON_NEAR = 0,
THIRD_PERSON_MEDIUM = 1,
Expand Down
56 changes: 30 additions & 26 deletions CAM/StopRenderingScriptCamsUsingCatchUp.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,32 +20,36 @@ enum eRenderingOptionFlags {

```c
enum eCamSplineSmoothingFlags {
CAM_SPLINE_NO_SMOOTH = 0, // No smoothing just moves at a constant rate
CAM_SPLINE_SLOW_IN_SMOOTH = 1, // Decelerates when approaching a node
CAM_SPLINE_SLOW_OUT_SMOOTH = 2, // Accelerates slowly when leaving a node
CAM_SPLINE_SLOW_IN_OUT_SMOOTH = 3, // Decelerates when approaching a node and accelerates slowly when leaving a node
CAM_SPLINE_VERY_SLOW_IN = 4,
CAM_SPLINE_VERY_SLOW_OUT = 5,
CAM_SPLINE_VERY_SLOW_IN_SLOW_OUT = 6,
CAM_SPLINE_SLOW_IN_VERY_SLOW_OUT = 7,
CAM_SPLINE_VERY_SLOW_IN_VERY_SLOW_OUT = 8,
CAM_SPLINE_EASE_IN = 9,
CAM_SPLINE_EASE_OUT = 10,
CAM_SPLINE_QUADRATIC_EASE_IN = 11,
CAM_SPLINE_QUADRATIC_EASE_OUT = 12,
CAM_SPLINE_QUADRATIC_EASE_IN_OUT = 13,
CAM_SPLINE_CUBIC_EASE_IN = 14,
CAM_SPLINE_CUBIC_EASE_OUT = 15,
CAM_SPLINE_CUBIC_EASE_IN_OUT = 16,
CAM_SPLINE_QUARTIC_EASE_IN = 17,
CAM_SPLINE_QUARTIC_EASE_OUT = 18,
CAM_SPLINE_QUARTIC_EASE_IN_OUT = 19,
CAM_SPLINE_QUINTIC_EASE_IN = 20,
CAM_SPLINE_QUINTIC_EASE_OUT = 21,
CAM_SPLINE_QUINTIC_EASE_IN_OUT = 22,
CAM_SPLINE_CIRCULAR_EASE_IN = 23,
CAM_SPLINE_CIRCULAR_EASE_OUT = 24,
CAM_SPLINE_CIRCULAR_EASE_IN_OUT = 25
// No smoothing just moves at a constant rate
CAM_SPLINE_NO_SMOOTH = 0,
// Decelerates when approaching a node
CAM_SPLINE_SLOW_IN_SMOOTH = 1,
// Accelerates slowly when leaving a node
CAM_SPLINE_SLOW_OUT_SMOOTH = 2,
// Decelerates when approaching a node and accelerates slowly when leaving a node
CAM_SPLINE_SLOW_IN_OUT_SMOOTH = 3,
CAM_SPLINE_VERY_SLOW_IN = 4,
CAM_SPLINE_VERY_SLOW_OUT = 5,
CAM_SPLINE_VERY_SLOW_IN_SLOW_OUT = 6,
CAM_SPLINE_SLOW_IN_VERY_SLOW_OUT = 7,
CAM_SPLINE_VERY_SLOW_IN_VERY_SLOW_OUT = 8,
CAM_SPLINE_EASE_IN = 9,
CAM_SPLINE_EASE_OUT = 10,
CAM_SPLINE_QUADRATIC_EASE_IN = 11,
CAM_SPLINE_QUADRATIC_EASE_OUT = 12,
CAM_SPLINE_QUADRATIC_EASE_IN_OUT = 13,
CAM_SPLINE_CUBIC_EASE_IN = 14,
CAM_SPLINE_CUBIC_EASE_OUT = 15,
CAM_SPLINE_CUBIC_EASE_IN_OUT = 16,
CAM_SPLINE_QUARTIC_EASE_IN = 17,
CAM_SPLINE_QUARTIC_EASE_OUT = 18,
CAM_SPLINE_QUARTIC_EASE_IN_OUT = 19,
CAM_SPLINE_QUINTIC_EASE_IN = 20,
CAM_SPLINE_QUINTIC_EASE_OUT = 21,
CAM_SPLINE_QUINTIC_EASE_IN_OUT = 22,
CAM_SPLINE_CIRCULAR_EASE_IN = 23,
CAM_SPLINE_CIRCULAR_EASE_OUT = 24,
CAM_SPLINE_CIRCULAR_EASE_IN_OUT = 25
};
```

Expand Down
6 changes: 2 additions & 4 deletions DECORATOR/DecorRegister.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,13 @@ ns: DECORATOR
void DECOR_REGISTER(char* propertyName, int type);
```
Decor types:
```
```c
enum eDecorType
{
DECOR_TYPE_FLOAT = 1,
DECOR_TYPE_BOOL = 2,
DECOR_TYPE_INT = 3,
DECOR_TYPE_UNK = 4,
DECOR_TYPE_STRING = 4,
DECOR_TYPE_TIME = 5
};
```
Expand Down
1 change: 0 additions & 1 deletion ENTITY/ApplyForceToEntityCenterOfMass.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ Apply a force to an entity.
* **bLocalForce**: Specifies whether the force vector passed in is in local or world coordinates. `true` means the force will get automatically transformed into world space before being applied
* **bScaleByMass**: Specifies whether to scale the force by mass
* **bApplyToChildren**: Default `false`. If the force should be applied to any attached children
30 changes: 16 additions & 14 deletions ENTITY/GetEntityRotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,31 @@ ns: ENTITY
Vector3 GET_ENTITY_ROTATION(Entity entity, int rotationOrder);
```
```
rotationOrder refers to the order yaw pitch roll is applied; value ranges from 0 to 5 and is usually *2* in scripts.
**NOTE**: What you use for rotationOrder when getting must be the same as rotationOrder when setting the rotation.
What you use for rotationOrder when getting must be the same as rotationOrder when setting the rotation.
What it returns is the yaw on the z part of the vector, which makes sense considering R* considers z as vertical. Here's a picture for those of you who don't understand pitch, yaw, and roll:
www.allstar.fiu.edu/aero/images/pic5-1.gif
```c
enum eRotationOrder {
// Rotate around the z-axis, then the y-axis and finally the x-axis.
ROT_ZYX = 0,
// Rotate around the y-axis, then the z-axis and finally the x-axis.
ROT_YZX = 1,
// Rotate around the z-axis, then the x-axis and finally the y-axis.
ROT_ZXY = 2,
// Rotate around the x-axis, then the z-axis and finally the y-axis.
ROT_XZY = 3,
// Rotate around the y-axis, then the x-axis and finally the z-axis.
ROT_YXZ = 4,
// Rotate around the x-axis, then the y-axis and finally the z-axis.
ROT_XYZ = 5,
}
```

### Rotation Orders
* **0**: ZYX - Rotate around the z-axis, then the y-axis and finally the x-axis.
* **1**: YZX - Rotate around the y-axis, then the z-axis and finally the x-axis.
* **2**: ZXY - Rotate around the z-axis, then the x-axis and finally the y-axis.
* **3**: XZY - Rotate around the x-axis, then the z-axis and finally the y-axis.
* **4**: YXZ - Rotate around the y-axis, then the x-axis and finally the z-axis.
* **5**: XYZ - Rotate around the x-axis, then the y-axis and finally the z-axis.
## Parameters
* **entity**: The entity to get the rotation for.
* **rotationOrder**: The order yaw, pitch and roll is applied. Usually 2.

## Return value
A vector where the Z coordinate is the yaw.

## Examples
Expand Down
174 changes: 87 additions & 87 deletions FIRE/AddExplosion.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,94 +18,94 @@ BOOL isInvisible = If the explosion is invisible or not.
BOOL noDamage = false: damage || nodamage = true: no damage
```
```cpp
enum class eExplosionTag : uint32_t
```c
enum eExplosionTag
{
DONTCARE = 0xFFFFFFFF,
GRENADE = 0,
GRENADELAUNCHER = 1,
STICKYBOMB = 2,
MOLOTOV = 3,
ROCKET = 4,
TANKSHELL = 5,
HI_OCTANE = 6,
CAR = 7,
PLANE = 8,
PETROL_PUMP = 9,
BIKE = 10,
DIR_STEAM = 11,
DIR_FLAME = 12,
DIR_WATER_HYDRANT = 13,
DIR_GAS_CANISTER = 14,
BOAT = 15,
SHIP_DESTROY = 16,
TRUCK = 17,
BULLET = 18,
SMOKEGRENADELAUNCHER = 19,
SMOKEGRENADE = 20,
BZGAS = 21,
FLARE = 22,
GAS_CANISTER = 23,
EXTINGUISHER = 24,
_0x988620B8 = 25,
EXP_TAG_TRAIN = 26,
EXP_TAG_BARREL = 27,
EXP_TAG_PROPANE = 28,
EXP_TAG_BLIMP = 29,
EXP_TAG_DIR_FLAME_EXPLODE = 30,
EXP_TAG_TANKER = 31,
PLANE_ROCKET = 32,
EXP_TAG_VEHICLE_BULLET = 33,
EXP_TAG_GAS_TANK = 34,
EXP_TAG_BIRD_CRAP = 35,
EXP_TAG_RAILGUN = 36,
EXP_TAG_BLIMP2 = 37,
EXP_TAG_FIREWORK = 38,
EXP_TAG_SNOWBALL = 39,
EXP_TAG_PROXMINE = 40,
EXP_TAG_VALKYRIE_CANNON = 41,
EXP_TAG_AIR_DEFENCE = 42,
EXP_TAG_PIPEBOMB = 43,
EXP_TAG_VEHICLEMINE = 44,
EXP_TAG_EXPLOSIVEAMMO = 45,
EXP_TAG_APCSHELL = 46,
EXP_TAG_BOMB_CLUSTER = 47,
EXP_TAG_BOMB_GAS = 48,
EXP_TAG_BOMB_INCENDIARY = 49,
EXP_TAG_BOMB_STANDARD = 50,
EXP_TAG_TORPEDO = 51,
EXP_TAG_TORPEDO_UNDERWATER = 52,
EXP_TAG_BOMBUSHKA_CANNON = 53,
EXP_TAG_BOMB_CLUSTER_SECONDARY = 54,
EXP_TAG_HUNTER_BARRAGE = 55,
EXP_TAG_HUNTER_CANNON = 56,
EXP_TAG_ROGUE_CANNON = 57,
EXP_TAG_MINE_UNDERWATER = 58,
EXP_TAG_ORBITAL_CANNON = 59,
EXP_TAG_BOMB_STANDARD_WIDE = 60,
EXP_TAG_EXPLOSIVEAMMO_SHOTGUN = 61,
EXP_TAG_OPPRESSOR2_CANNON = 62,
EXP_TAG_MORTAR_KINETIC = 63,
EXP_TAG_VEHICLEMINE_KINETIC = 64,
EXP_TAG_VEHICLEMINE_EMP = 65,
EXP_TAG_VEHICLEMINE_SPIKE = 66,
EXP_TAG_VEHICLEMINE_SLICK = 67,
EXP_TAG_VEHICLEMINE_TAR = 68,
EXP_TAG_SCRIPT_DRONE = 69,
EXP_TAG_RAYGUN = 70,
EXP_TAG_BURIEDMINE = 71,
EXP_TAG_SCRIPT_MISSILE = 72,
EXP_TAG_RCTANK_ROCKET = 73,
EXP_TAG_BOMB_WATER = 74,
EXP_TAG_BOMB_WATER_SECONDARY = 75,
EXP_TAG_MINE_CNCSPIKE = 76,
EXP_TAG_BZGAS_MK2 = 77,
EXP_TAG_FLASHGRENADE = 78,
EXP_TAG_STUNGRENADE = 79,
EXP_TAG_CNC_KINETICRAM = 80,
EXP_TAG_SCRIPT_MISSILE_LARGE = 81,
EXP_TAG_SUBMARINE_BIG = 82,
EXP_TAG_EMPLAUNCHER_EMP = 83,
DONTCARE = -1,
GRENADE = 0,
GRENADELAUNCHER = 1,
STICKYBOMB = 2,
MOLOTOV = 3,
ROCKET = 4,
TANKSHELL = 5,
HI_OCTANE = 6,
CAR = 7,
PLANE = 8,
PETROL_PUMP = 9,
BIKE = 10,
DIR_STEAM = 11,
DIR_FLAME = 12,
DIR_WATER_HYDRANT = 13,
DIR_GAS_CANISTER = 14,
BOAT = 15,
SHIP_DESTROY = 16,
TRUCK = 17,
BULLET = 18,
SMOKE_GRENADE_LAUNCHER = 19,
SMOKE_GRENADE = 20,
BZGAS = 21,
FLARE = 22,
GAS_CANISTER = 23,
EXTINGUISHER = 24,
PROGRAMMABLEAR = 25,
TRAIN = 26,
BARREL = 27,
PROPANE = 28,
BLIMP = 29,
DIR_FLAME_EXPLODE = 30,
TANKER = 31,
PLANE_ROCKET = 32,
VEHICLE_BULLET = 33,
GAS_TANK = 34,
BIRD_CRAP = 35,
RAILGUN = 36,
BLIMP2 = 37,
FIREWORK = 38,
SNOWBALL = 39,
PROXMINE = 40,
VALKYRIE_CANNON = 41,
AIR_DEFENCE = 42,
PIPEBOMB = 43,
VEHICLEMINE = 44,
EXPLOSIVEAMMO = 45,
APCSHELL = 46,
BOMB_CLUSTER = 47,
BOMB_GAS = 48,
BOMB_INCENDIARY = 49,
BOMB_STANDARD = 50,
TORPEDO = 51,
TORPEDO_UNDERWATER = 52,
BOMBUSHKA_CANNON = 53,
BOMB_CLUSTER_SECONDARY = 54,
HUNTER_BARRAGE = 55,
HUNTER_CANNON = 56,
ROGUE_CANNON = 57,
MINE_UNDERWATER = 58,
ORBITAL_CANNON = 59,
BOMB_STANDARD_WIDE = 60,
EXPLOSIVEAMMO_SHOTGUN = 61,
OPPRESSOR2_CANNON = 62,
MORTAR_KINETIC = 63,
VEHICLEMINE_KINETIC = 64,
VEHICLEMINE_EMP = 65,
VEHICLEMINE_SPIKE = 66,
VEHICLEMINE_SLICK = 67,
VEHICLEMINE_TAR = 68,
SCRIPT_DRONE = 69,
RAYGUN = 70,
BURIEDMINE = 71,
SCRIPT_MISSILE = 72,
RCTANK_ROCKET = 73,
BOMB_WATER = 74,
BOMB_WATER_SECONDARY = 75,
MINE_CNCSPIKE = 76,
BZGAS_MK2 = 77,
FLASHGRENADE = 78,
STUNGRENADE = 79,
CNC_KINETICRAM = 80,
SCRIPT_MISSILE_LARGE = 81,
SUBMARINE_BIG = 82,
EMPLAUNCHER_EMP = 83
};
```

Expand Down
Loading

0 comments on commit 1b2a4fd

Please sign in to comment.