@citizenfx/client 2.0.16973-1 → 2.0.17000-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7537,6 +7537,11 @@ declare function DrawInteractiveSprite(textureDict: string, textureName: string,
7537
7537
  */
7538
7538
  declare function N_0x2bc54a8188768488(textureDict: string, textureName: string, screenX: number, screenY: number, width: number, height: number, heading: number, red: number, green: number, blue: number, alpha: number): void;
7539
7539
 
7540
+ /**
7541
+ * Draw the prepared light.
7542
+ */
7543
+ declare function DrawLight(): void;
7544
+
7540
7545
  /**
7541
7546
  * DRAW_LIGHT_WITH_RANGE
7542
7547
  */
@@ -15619,24 +15624,24 @@ declare function GetPedEventData(ped: number, eventType: number, outData?: numbe
15619
15624
  declare function GetPedExtractedDisplacement(ped: number, worldSpace: boolean): number[];
15620
15625
 
15621
15626
  /**
15622
- * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
15627
+ * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
15623
15628
  * @param ped The target ped
15624
15629
  * @return Returns ped's eye colour, or -1 if fails to get.
15625
15630
  */
15626
15631
  declare function GetPedEyeColor(ped: number): number;
15627
-
15628
15632
  /**
15629
15633
  * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
15630
15634
  * @param ped The target ped
15631
15635
  * @return Returns ped's eye colour, or -1 if fails to get.
15632
15636
  */
15633
- declare function GetPedEyeColor(ped: number): number;
15637
+ declare function N_0x76bba2cee66d47e9(ped: number): number;
15638
+
15634
15639
  /**
15635
- * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
15640
+ * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
15636
15641
  * @param ped The target ped
15637
15642
  * @return Returns ped's eye colour, or -1 if fails to get.
15638
15643
  */
15639
- declare function N_0x76bba2cee66d47e9(ped: number): number;
15644
+ declare function GetPedEyeColor(ped: number): number;
15640
15645
 
15641
15646
  /**
15642
15647
  * A getter for [\_SET_PED_FACE_FEATURE](#\_0x71A5C1DBA060049E). Returns 0.0 if fails to get.
@@ -40757,6 +40762,20 @@ declare function PreloadVehicleMod(p0: number, modType: number, p2: number): voi
40757
40762
  */
40758
40763
  declare function PrepareAlarm(alarmName: string): boolean;
40759
40764
 
40765
+ /**
40766
+ * Create a new light with specified type, flags, position, color, and intensity.
40767
+ * @param lightType The type of the light
40768
+ * @param flags Light flags
40769
+ * @param x X coordinate of the light position
40770
+ * @param y Y coordinate of the light position
40771
+ * @param z Z coordinate of the light position
40772
+ * @param r Red component of the light color (0-255)
40773
+ * @param g Green component of the light color (0-255)
40774
+ * @param b Blue component of the light color (0-255)
40775
+ * @param intensity Intensity of the light
40776
+ */
40777
+ declare function PrepareLight(lightType: number, flags: number, x: number, y: number, z: number, r: number, g: number, b: number, intensity: number): void;
40778
+
40760
40779
  /**
40761
40780
  * Prepares the specified music event. Preparing it in advance will preload any required data so that it's ready to play immediately.
40762
40781
  * @return Returns true if the event is prepared, false otherwise
@@ -48738,6 +48757,179 @@ declare function SetLaunchControlEnabled(toggle: boolean): void;
48738
48757
  */
48739
48758
  declare function N_0xaa6a6098851c396f(toggle: boolean): void;
48740
48759
 
48760
+ /**
48761
+ * Set the alpha transparency of the light.
48762
+ * @param alpha The alpha transparency value (0.0 to 1.0)
48763
+ */
48764
+ declare function SetLightAlpha(alpha: number): void;
48765
+
48766
+ /**
48767
+ * Set ambient occlusion (AO) parameters for a specified light.
48768
+ * @param intensity The AO intensity
48769
+ * @param radius The AO radius
48770
+ * @param bias The AO bias
48771
+ * @param intensity2 Secondary AO intensity
48772
+ */
48773
+ declare function SetLightAo(intensity: number, radius: number, bias: number, intensity2: number): void;
48774
+
48775
+ /**
48776
+ * Set the capsule size of a specified light.
48777
+ * @param size The capsule size value
48778
+ */
48779
+ declare function SetLightCapsuleSize(size: number): void;
48780
+
48781
+ /**
48782
+ * Set the clip rectangle for a created light.
48783
+ * @param x The x-coordinate of the clip rectangle
48784
+ * @param y The y-coordinate of the clip rectangle
48785
+ * @param width The width of the clip rectangle
48786
+ * @param height The height of the clip rectangle
48787
+ */
48788
+ declare function SetLightClipRect(x: number, y: number, width: number, height: number): void;
48789
+
48790
+ /**
48791
+ * Set the color of a specified light.
48792
+ * @param r Red color component (0-255)
48793
+ * @param g Green color component (0-255)
48794
+ * @param b Blue color component (0-255)
48795
+ */
48796
+ declare function SetLightColor(r: number, g: number, b: number): void;
48797
+
48798
+ /**
48799
+ * Set the inner and outer cone angles of a specified light.
48800
+ * @param innerConeAngle The inner cone angle in degrees
48801
+ * @param outerConeAngle The outer cone angle in degrees
48802
+ */
48803
+ declare function SetLightCone(innerConeAngle: number, outerConeAngle: number): void;
48804
+
48805
+ /**
48806
+ * Set the world coordinates of a specified light.
48807
+ * @param x The X coordinate
48808
+ * @param y The Y coordinate
48809
+ * @param z The Z coordinate
48810
+ */
48811
+ declare function SetLightCoords(x: number, y: number, z: number): void;
48812
+
48813
+ /**
48814
+ * Set the forward and tangent direction vectors for an existing light, allowing control over its orientation (useful for spotlights and directional lights).
48815
+ * @param xDir , **yDir**, **zDir**: Components of the normalized forward (direction) vector
48816
+ * @param xTanDir , **yTanDir**, **zTanDir**: Components of the normalized tangent vector (defines rotation around the forward axis)
48817
+ */
48818
+ declare function SetLightDirection(xDir: number, yDir: number, zDir: number, xTanDir: number, yTanDir: number, zTanDir: number): void;
48819
+
48820
+ /**
48821
+ * Set additional configuration flags for an existing light
48822
+ * @param extraFlags Bitmask of extra flags
48823
+ */
48824
+ declare function SetLightExtraflags(extraFlags: number): void;
48825
+
48826
+ /**
48827
+ * Set the fade distance.
48828
+ * @param fadeDistance Maximum distance
48829
+ */
48830
+ declare function SetLightFadeDistance(fadeDistance: number): void;
48831
+
48832
+ /**
48833
+ * Adjust the falloff parameter for an existing light, affecting how light intensity decreases over distance.
48834
+ * @param falloff A floating‑point value determining the rate at which light intensity diminishes with distance (must be > 0; values ≤ 0 will be clamped internally)
48835
+ */
48836
+ declare function SetLightFalloff(falloff: number): void;
48837
+
48838
+ /**
48839
+ * Set or update specific flags for a created light to control its behavior or properties.
48840
+ * @param flags Bitmask of flags to apply to the light
48841
+ */
48842
+ declare function SetLightFlags(flags: number): void;
48843
+
48844
+ /**
48845
+ * Set the headlight properties of a created light, adjusting its intensity and range.
48846
+ * @param intensity The intensity level of the headlight
48847
+ * @param range The effective range of the headlight
48848
+ */
48849
+ declare function SetLightHeadlight(intensity: number, range: number): void;
48850
+
48851
+ /**
48852
+ * Set the intensity of an existing light.
48853
+ * @param intensity The intensity value to set
48854
+ */
48855
+ declare function SetLightIntensity(intensity: number): void;
48856
+
48857
+ /**
48858
+ * Set the interior and room where the light should be active.
48859
+ * @param interiorId The ID of the interior where the light should be active
48860
+ * @param isPortal Attach to a portal or room
48861
+ * @param roomIndex The specific room
48862
+ */
48863
+ declare function SetLightInterior(interiorId: number, isPortal: boolean, roomIndex: number): void;
48864
+
48865
+ /**
48866
+ * Set the plane parameters for a light.
48867
+ * @param x X component of the plane
48868
+ * @param y Y component of the plane
48869
+ * @param z Z component of the plane
48870
+ * @param w W component of the plane
48871
+ */
48872
+ declare function SetLightPlane(x: number, y: number, z: number, w: number): void;
48873
+
48874
+ /**
48875
+ * Set the radius of a created light.
48876
+ * @param radius The radius value to set
48877
+ */
48878
+ declare function SetLightRadius(radius: number): void;
48879
+
48880
+ /**
48881
+ * Set the shadow details for a created light.
48882
+ * @param shadowFlags Flags controlling shadow behavior
48883
+ * @param shadowDistance The distance at which shadows are rendered
48884
+ * @param shadowFade The fade distance for shadows
48885
+ * @param shadowDepthBiasScale The depth bias scale
48886
+ */
48887
+ declare function SetLightShadowDetails(shadowFlags: number, shadowDistance: number, shadowFade: number, shadowDepthBiasScale: number): void;
48888
+
48889
+ /**
48890
+ * Set the fade distance for the shadows of a created light.
48891
+ * @param fadeDistance The distance at which the shadow fades
48892
+ */
48893
+ declare function SetLightShadowFadeDistance(fadeDistance: number): void;
48894
+
48895
+ /**
48896
+ * Set the specular fade distance for a created light.
48897
+ * @param fadeDistance The distance at which specular highlights fade
48898
+ */
48899
+ declare function SetLightSpecularFadeDistance(fadeDistance: number): void;
48900
+
48901
+ /**
48902
+ * Assign a texture to an existing light source, allowing custom light shapes or patterns using textures from streaming assets.
48903
+ * @param textureDict The name of the texture dictionary (TXD) containing the texture
48904
+ * @param textureHash Hash of the texture
48905
+ */
48906
+ declare function SetLightTexture(textureDict: string, textureHash: number): void;
48907
+
48908
+ /**
48909
+ * Change the light type of a already created light.
48910
+ * Certain light type needs more configurations to work properly (Like direction, flags or size)
48911
+ * @param lightType The type of light
48912
+ */
48913
+ declare function SetLightType(lightType: number): void;
48914
+
48915
+ /**
48916
+ * Set volumetric light properties for an existing light, enabling custom volumetric effects such as fog-like glow.
48917
+ * @param volIntensity Intensity of the volumetric effect
48918
+ * @param volSizeScale Scale of the volumetric volume
48919
+ * @param r Red channel for volumetric outer color (0–255)
48920
+ * @param g Green channel for volumetric outer color (0–255)
48921
+ * @param b Blue channel for volumetric outer color (0–255)
48922
+ * @param i Intensity (alpha) of the volumetric outer color
48923
+ * @param outerExponent Exponent controlling falloff of the volumetric outer glow
48924
+ */
48925
+ declare function SetLightVolumeDetails(volIntensity: number, volSizeScale: number, r: number, g: number, b: number, i: number, outerExponent: number): void;
48926
+
48927
+ /**
48928
+ * Set the fade distance for volumetric lightingn.
48929
+ * @param volumetricFadeDistance The maximum distance
48930
+ */
48931
+ declare function SetLightVolumetricFadeDistance(volumetricFadeDistance: number): void;
48932
+
48741
48933
  /**
48742
48934
  * SET_LIGHTS_CUTOFF_DISTANCE_TWEAK
48743
48935
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@citizenfx/client",
3
- "version": "2.0.16973-1",
3
+ "version": "2.0.17000-1",
4
4
  "description": "Typings for the CitizenFX client JS API.",
5
5
  "main": "index.js",
6
6
  "scripts": {