Requests

Lightweight utility wrappers for native CFX request functions.


Accessing the Module

local REQUESTS <const> = exports.boii_utils:get("modules.requests")

Client

model(model)

Requests and loads a model.

Parameters

Name
Type
Description

model

hash

Hash of the model to load

Example

REQUESTS.model(GetHashKey("prop_bench_01a"))

interior(interior)

Requests and loads an interior.

Parameters

Name
Type
Description

interior

number

Interior ID to load

Example


texture(texture, wait)

Requests and optionally waits for a texture dictionary to load.

Parameters

Name
Type
Description

texture

string

Texture dictionary name

wait

boolean

Whether to wait for the load

Example


collision(x, y, z)

Requests collision around a coordinate.

Parameters

Name
Type
Description

x

number

X coordinate

y

number

Y coordinate

z

number

Z coordinate

Example


anim(dict)

Requests and loads an animation dictionary.

Parameters

Name
Type
Description

dict

string

Animation dictionary name

Example


anim_set(set)

Requests and loads an animation set.

Parameters

Name
Type
Description

set

string

Animation set name

Example


clip_set(clip)

Requests and loads an animation clip set.

Parameters

Name
Type
Description

clip

string

Clip set name

Example


audio_bank(audio)

Requests and loads a script audio bank.

Parameters

Name
Type
Description

audio

string

Audio bank name

Example


scaleform_movie(scaleform)

Requests and loads a scaleform movie.

Parameters

Name
Type
Description

scaleform

string

Name of the scaleform

Returns

Type
Description

number

Handle to the scaleform

Example


cutscene(scene)

Requests and loads a cutscene.

Parameters

Name
Type
Description

scene

string

Cutscene name

Example


ipl(str)

Requests and loads an IPL (map file).

Parameters

Name
Type
Description

str

string

IPL name to load

Example

Last updated