Skip to content

VimpNativesStreaming ​

@vimp-mp/types 2.0.1

Interface · GTA V natives API

ts
interface VimpNativesStreaming

Members ​

addModelToCreatorBudget ​

ts
addModelToCreatorBudget(modelhash: number): boolean

allowPlayerSwitchAscent ​

ts
allowPlayerSwitchAscent(): void

allowPlayerSwitchDescent ​

ts
allowPlayerSwitchDescent(): void

allowPlayerSwitchOutro ​

ts
allowPlayerSwitchOutro(): void

allowPlayerSwitchPan ​

ts
allowPlayerSwitchPan(): void

beginSrl ​

ts
beginSrl(): void

clearFocus ​

ts
clearFocus(): void

clearHdArea ​

ts
clearHdArea(): void

disableSwitchOutroFx ​

ts
disableSwitchOutroFx(): void

doesAnimDictExist ​

ts
doesAnimDictExist(animdict: string): boolean

enableSwitchPauseBeforeDescent ​

ts
enableSwitchPauseBeforeDescent(): void

endSrl ​

ts
endSrl(): void

forceAllowTimeBasedFadingThisFrame ​

ts
forceAllowTimeBasedFadingThisFrame(): void

getGlobalWaterFile ​

ts
getGlobalWaterFile(): number

getIdealPlayerSwitchType ​

ts
getIdealPlayerSwitchType(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number): number

getLodscale ​

ts
getLodscale(): number

getNumberOfStreamingRequests ​

ts
getNumberOfStreamingRequests(): number

getPlayerShortSwitchState ​

ts
getPlayerShortSwitchState(): number

getPlayerSwitchInterpOutCurrentTime ​

ts
getPlayerSwitchInterpOutCurrentTime(): number

getPlayerSwitchInterpOutDuration ​

ts
getPlayerSwitchInterpOutDuration(): number

getPlayerSwitchJumpCutIndex ​

ts
getPlayerSwitchJumpCutIndex(): number

getPlayerSwitchState ​

ts
getPlayerSwitchState(): number

getPlayerSwitchType ​

ts
getPlayerSwitchType(): number

getUsedCreatorBudget ​

ts
getUsedCreatorBudget(): number

hasAnimDictLoaded ​

ts
hasAnimDictLoaded(animdict: string): boolean

hasAnimSetLoaded ​

ts
hasAnimSetLoaded(animset: string): boolean

hasClipSetLoaded ​

ts
hasClipSetLoaded(clipset: string): boolean

hasCollisionForModelLoaded ​

ts
hasCollisionForModelLoaded(model: number): boolean

hasModelLoaded ​

ts
hasModelLoaded(model: number): boolean

hasNamedPtfxAssetLoaded ​

ts
hasNamedPtfxAssetLoaded(fxname: string): boolean

hasPtfxAssetLoaded ​

ts
hasPtfxAssetLoaded(): boolean

initCreatorBudget ​

ts
initCreatorBudget(): void

iplGroupSwapCancel ​

ts
iplGroupSwapCancel(): void

iplGroupSwapFinish ​

ts
iplGroupSwapFinish(): void

iplGroupSwapIsActive ​

ts
iplGroupSwapIsActive(): boolean

iplGroupSwapIsReady ​

ts
iplGroupSwapIsReady(): boolean

iplGroupSwapStart ​

ts
iplGroupSwapStart(iplname1: string, iplname2: string): void

isEntityFocus ​

ts
isEntityFocus(entity: number): boolean

isIplActive ​

ts
isIplActive(iplname: string): boolean

isModelAPed ​

ts
isModelAPed(model: number): boolean

isModelAVehicle ​

ts
isModelAVehicle(model: number): boolean

isModelInCdimage ​

ts
isModelInCdimage(model: number): boolean

isModelValid ​

ts
isModelValid(model: number): boolean

isNetworkLoadingScene ​

ts
isNetworkLoadingScene(): boolean

isNewLoadSceneActive ​

ts
isNewLoadSceneActive(): boolean

isNewLoadSceneLoaded ​

ts
isNewLoadSceneLoaded(): boolean

isPlayerSwitchInProgress ​

ts
isPlayerSwitchInProgress(): boolean

isSafeToStartPlayerSwitch ​

ts
isSafeToStartPlayerSwitch(): boolean

isSrlLoaded ​

ts
isSrlLoaded(): boolean

isStreamvolActive ​

ts
isStreamvolActive(): boolean

isSwitchReadyForDescent ​

ts
isSwitchReadyForDescent(): boolean

isSwitchSkippingDescent ​

ts
isSwitchSkippingDescent(): boolean

isSwitchToMultiFirstpartFinished ​

ts
isSwitchToMultiFirstpartFinished(): boolean

loadAllObjectsNow ​

ts
loadAllObjectsNow(): void

loadGlobalWaterFile ​

ts
loadGlobalWaterFile(watertype: number): void

loadScene ​

ts
loadScene(x: number, y: number, z: number): void

networkUpdateLoadScene ​

ts
networkUpdateLoadScene(): boolean

newLoadSceneStart ​

ts
newLoadSceneStart(posx: number, posy: number, posz: number, offsetx: number, offsety: number, offsetz: number, radius: number, p7: number): boolean

newLoadSceneStartSphere ​

ts
newLoadSceneStartSphere(x: number, y: number, z: number, radius: number, p4: number): boolean

newLoadSceneStop ​

ts
newLoadSceneStop(): void

overrideLodscaleThisFrame ​

ts
overrideLodscaleThisFrame(scaling: number): void

prefetchSrl ​

ts
prefetchSrl(srl: string): void

remapLodscaleRangeThisFrame ​

ts
remapLodscaleRangeThisFrame(p0: number, p1: number, p2: number, p3: number): void

removeAnimDict ​

ts
removeAnimDict(animdict: string): void

removeAnimSet ​

ts
removeAnimSet(animset: string): void

removeClipSet ​

ts
removeClipSet(clipset: string): void

removeIpl ​

ts
removeIpl(iplname: string): void

removeModelFromCreatorBudget ​

ts
removeModelFromCreatorBudget(modelhash: number): void

removeNamedPtfxAsset ​

ts
removeNamedPtfxAsset(fxname: string): void

removePtfxAsset ​

ts
removePtfxAsset(): void

requestAdditionalCollisionAtCoord ​

ts
requestAdditionalCollisionAtCoord(x: number, y: number, z: number): void

requestAnimDict ​

ts
requestAnimDict(animdict: string): void

requestAnimSet ​

ts
requestAnimSet(animset: string): void

requestClipSet ​

ts
requestClipSet(clipset: string): void

requestCollisionAtCoord ​

ts
requestCollisionAtCoord(x: number, y: number, z: number): void

requestCollisionForModel ​

ts
requestCollisionForModel(model: number): void

requestIpl ​

ts
requestIpl(iplname: string): void

requestMenuPedModel ​

ts
requestMenuPedModel(model: number): void

requestModel ​

ts
requestModel(model: number): void

requestModelsInRoom ​

ts
requestModelsInRoom(interior: number, roomname: string): void

requestNamedPtfxAsset ​

ts
requestNamedPtfxAsset(fxname: string): void

requestPtfxAsset ​

ts
requestPtfxAsset(): void

setAllMapdataCulled ​

ts
setAllMapdataCulled(p0: number): void

setDitchPoliceModels ​

ts
setDitchPoliceModels(toggle: boolean): void

setFocusEntity ​

ts
setFocusEntity(entity: number): void

setFocusPosAndVel ​

ts
setFocusPosAndVel(x: number, y: number, z: number, offsetx: number, offsety: number, offsetz: number): void

setGamePausesForStreaming ​

ts
setGamePausesForStreaming(toggle: boolean): void

setHdArea ​

ts
setHdArea(x: number, y: number, z: number, radius: number): void

setInteriorActive ​

ts
setInteriorActive(interiorid: number, toggle: boolean): void

setIslandEnabled ​

ts
setIslandEnabled(name: string, toggle: boolean): void

setMapdatacullboxEnabled ​

ts
setMapdatacullboxEnabled(name: string, toggle: boolean): void

setModelAsNoLongerNeeded ​

ts
setModelAsNoLongerNeeded(model: number): void

setPedPopulationBudget ​

ts
setPedPopulationBudget(p0: number): void

setPlayerShortSwitchStyle ​

ts
setPlayerShortSwitchStyle(p0: number): void

setPlayerSwitchEstablishingShot ​

ts
setPlayerSwitchEstablishingShot(name: string): void

setPlayerSwitchOutro ​

ts
setPlayerSwitchOutro(cameracoordx: number, cameracoordy: number, cameracoordz: number, camrotationx: number, camrotationy: number, camrotationz: number, camfov: number, camfarclip: number, rotationorder: number): void

setReducePedModelBudget ​

ts
setReducePedModelBudget(toggle: boolean): void

setReduceVehicleModelBudget ​

ts
setReduceVehicleModelBudget(toggle: boolean): void

setRenderHdOnly ​

ts
setRenderHdOnly(toggle: boolean): void

setRestoreFocusEntity ​

ts
setRestoreFocusEntity(p0: number): void

setSceneStreamingTracksCamPosThisFrame ​

ts
setSceneStreamingTracksCamPosThisFrame(): void

setSrlForcePrestream ​

ts
setSrlForcePrestream(p0: number): void

setSrlLongJumpMode ​

ts
setSrlLongJumpMode(p0: boolean): void

setSrlPostCutsceneCamera ​

ts
setSrlPostCutsceneCamera(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number): void

setSrlReadaheadTimes ​

ts
setSrlReadaheadTimes(p0: number, p1: number, p2: number, p3: number): void

setSrlTime ​

ts
setSrlTime(p0: number): void

setStreaming ​

ts
setStreaming(toggle: boolean): void

setVehiclePopulationBudget ​

ts
setVehiclePopulationBudget(p0: number): void

shutdownCreatorBudget ​

ts
shutdownCreatorBudget(): void

startPlayerSwitch ​

ts
startPlayerSwitch(from: number, to: number, flags: number, switchtype: number): void

stopPlayerSwitch ​

ts
stopPlayerSwitch(): void

streamvolCreateFrustum ​

ts
streamvolCreateFrustum(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number, p7: number, p8: number): number

streamvolCreateLine ​

ts
streamvolCreateLine(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number): number

streamvolCreateSphere ​

ts
streamvolCreateSphere(x: number, y: number, z: number, rad: number, p4: number, p5: number): number

streamvolDelete ​

ts
streamvolDelete(unused: number): void

streamvolHasLoaded ​

ts
streamvolHasLoaded(unused: number): boolean

streamvolIsValid ​

ts
streamvolIsValid(unused: number): boolean

suppressHdMapStreamingThisFrame ​

ts
suppressHdMapStreamingThisFrame(): void

switchToMultiFirstpart ​

ts
switchToMultiFirstpart(ped: number, flags: number, switchtype: number): void

switchToMultiSecondpart ​

ts
switchToMultiSecondpart(ped: number): void

VIMP developer documentation