Skip to content

VimpNativesObject ​

@vimp-mp/types 2.0.1

Interface · GTA V natives API

ts
interface VimpNativesObject

Members ​

_setObjectTargettableByPlayer ​

ts
_setObjectTargettableByPlayer(object: number, setflag34: boolean, setflag35: boolean): void

_setPickupGlowDisabled ​

ts
_setPickupGlowDisabled(pickup: number, toggle: boolean): void

addDoorToSystem ​

ts
addDoorToSystem(doorhash: number, modelhash: number, x: number, y: number, z: number, p5: boolean, scriptdoor: boolean, islocal: boolean, p8: number): void

addExtendedPickupProbeArea ​

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

allowAllPlayersToCollectPickupsOfType ​

ts
allowAllPlayersToCollectPickupsOfType(pickuphash: number): void

allowDamageEventsForNonNetworkedObjects ​

ts
allowDamageEventsForNonNetworkedObjects(value: boolean): void

allowPickupArrowMarkerWhenUncollectable ​

ts
allowPickupArrowMarkerWhenUncollectable(pickup: number, toggle: boolean): void

allowPickupByNoneParticipant ​

ts
allowPickupByNoneParticipant(pickup: number, toggle: boolean): void

allowPortablePickupToMigrateToNonParticipants ​

ts
allowPortablePickupToMigrateToNonParticipants(pickup: number, toggle: boolean): void

areEntitiesEntirelyInsideGarage ​

ts
areEntitiesEntirelyInsideGarage(garagehash: number, p1: boolean, p2: boolean, p3: boolean, p4: number): boolean

attachPortablePickupToPed ​

ts
attachPortablePickupToPed(pickupobject: number, ped: number): void

blockPlayersForAmbientPickup ​

ts
blockPlayersForAmbientPickup(p0: number, p1: number): void

breakObjectFragmentChild ​

ts
breakObjectFragmentChild(p0: number, p1: number, p2: boolean): void

clearAllPickupRewardTypeSuppression ​

ts
clearAllPickupRewardTypeSuppression(): void

clearExtendedPickupProbeAreas ​

ts
clearExtendedPickupProbeAreas(): void

clearGarage ​

ts
clearGarage(garagehash: number, isnetwork: boolean): void

clearObjectsInsideGarage ​

ts
clearObjectsInsideGarage(garagehash: number, vehicles: boolean, peds: boolean, objects: boolean, isnetwork: boolean): void

clearPickupRewardTypeSuppression ​

ts
clearPickupRewardTypeSuppression(rewardtype: number): void

closeAllBarriersForRace ​

ts
closeAllBarriersForRace(): void

closeSafehouseGarages ​

ts
closeSafehouseGarages(): void

convertOldPickupTypeToNew ​

ts
convertOldPickupTypeToNew(pickuphash: number): number

createAmbientPickup ​

ts
createAmbientPickup(pickuphash: number, posx: number, posy: number, posz: number, flags: number, value: number, modelhash: number, p7: boolean, p8: boolean): number

createMoneyPickups ​

ts
createMoneyPickups(x: number, y: number, z: number, value: number, amount: number, model: number): void

createNonNetworkedAmbientPickup ​

ts
createNonNetworkedAmbientPickup(pickuphash: number, posx: number, posy: number, posz: number, flags: number, value: number, modelhash: number, p7: boolean, p8: boolean): number

createNonNetworkedPortablePickup ​

ts
createNonNetworkedPortablePickup(pickuphash: number, x: number, y: number, z: number, placeonground: boolean, modelhash: number): number

createObject ​

ts
createObject(modelhash: number, x: number, y: number, z: number, isnetwork: boolean, bscripthostobj: boolean, dynamic: boolean): number

createObjectNoOffset ​

ts
createObjectNoOffset(modelhash: number, x: number, y: number, z: number, isnetwork: boolean, bscripthostobj: boolean, dynamic: boolean, p7: number): number

createPickup ​

ts
createPickup(pickuphash: number, posx: number, posy: number, posz: number, p4: number, value: number, p6: boolean, modelhash: number): number

createPickupRotate ​

ts
createPickupRotate(pickuphash: number, posx: number, posy: number, posz: number, rotx: number, roty: number, rotz: number, flag: number, amount: number, p9: number, p10: boolean, modelhash: number): number

createPortablePickup ​

ts
createPortablePickup(pickuphash: number, x: number, y: number, z: number, placeonground: boolean, modelhash: number): number

damageObjectFragmentChild ​

ts
damageObjectFragmentChild(p0: number, p1: number, p2: number): void

deleteObject ​

ts
deleteObject(): { object: number }

detachPortablePickupFromPed ​

ts
detachPortablePickupFromPed(pickupobject: number): void

disableTidyingUpInGarage ​

ts
disableTidyingUpInGarage(id: number, toggle: boolean): void

doesObjectOfTypeExistAtCoords ​

ts
doesObjectOfTypeExistAtCoords(x: number, y: number, z: number, radius: number, hash: number, p5: boolean): boolean

doesPickupExist ​

ts
doesPickupExist(pickup: number): boolean

doesPickupObjectExist ​

ts
doesPickupObjectExist(pickupobject: number): boolean

doesPickupOfTypeExistInArea ​

ts
doesPickupOfTypeExistInArea(pickuphash: number, x: number, y: number, z: number, radius: number): boolean

doesRayfireMapObjectExist ​

ts
doesRayfireMapObjectExist(object: number): boolean

doorSystemFindExistingDoor ​

ts
doorSystemFindExistingDoor(x: number, y: number, z: number, modelhash: number): { outdoorhash: number; return: boolean }

doorSystemGetAutomaticDistance ​

ts
doorSystemGetAutomaticDistance(doorhash: number): number

doorSystemGetDoorPendingState ​

ts
doorSystemGetDoorPendingState(doorhash: number): number

doorSystemGetDoorState ​

ts
doorSystemGetDoorState(doorhash: number): number

doorSystemGetIsPhysicsLoaded ​

ts
doorSystemGetIsPhysicsLoaded(p0: number): boolean

doorSystemGetIsSpringRemoved ​

ts
doorSystemGetIsSpringRemoved(doorhash: number): boolean

doorSystemGetOpenRatio ​

ts
doorSystemGetOpenRatio(doorhash: number): number

doorSystemSetAutomaticDistance ​

ts
doorSystemSetAutomaticDistance(doorhash: number, distance: number, requestdoor: boolean, forceupdate: boolean): void

doorSystemSetAutomaticRate ​

ts
doorSystemSetAutomaticRate(doorhash: number, rate: number, requestdoor: boolean, forceupdate: boolean): void

doorSystemSetDoorOpenForRaces ​

ts
doorSystemSetDoorOpenForRaces(doorhash: number, p1: boolean): void

doorSystemSetDoorState ​

ts
doorSystemSetDoorState(doorhash: number, state: number, requestdoor: boolean, forceupdate: boolean): void

doorSystemSetHoldOpen ​

ts
doorSystemSetHoldOpen(doorhash: number, toggle: boolean): void

doorSystemSetOpenRatio ​

ts
doorSystemSetOpenRatio(doorhash: number, ajar: number, requestdoor: boolean, forceupdate: boolean): void

doorSystemSetSpringRemoved ​

ts
doorSystemSetSpringRemoved(doorhash: number, removed: boolean, requestdoor: boolean, forceupdate: boolean): void

enableSavingInGarage ​

ts
enableSavingInGarage(garagehash: number, toggle: boolean): void

fixObjectFragment ​

ts
fixObjectFragment(object: number): void

forceActivatePhysicsOnUnfixedPickup ​

ts
forceActivatePhysicsOnUnfixedPickup(pickup: number, toggle: boolean): void

forcePickupRegenerate ​

ts
forcePickupRegenerate(p0: number): void

forcePickupRotateFaceUp ​

ts
forcePickupRotateFaceUp(): void

forcePortablePickupLastAccessiblePositionSetting ​

ts
forcePortablePickupLastAccessiblePositionSetting(object: number): void

getClosestObjectOfType ​

ts
getClosestObjectOfType(x: number, y: number, z: number, radius: number, modelhash: number, ismission: boolean, p6: boolean, p7: boolean): number

getCoordsAndRotationOfClosestObjectOfType ​

ts
getCoordsAndRotationOfClosestObjectOfType(x: number, y: number, z: number, radius: number, modelhash: number, rotationorder: number): { outposition: { x: number; y: number; z: number }; outrotation: { x: number; y: number; z: number }; return: boolean }

getDefaultAmmoForWeaponPickup ​

ts
getDefaultAmmoForWeaponPickup(pickuphash: number): number

getHasObjectBeenCompletelyDestroyed ​

ts
getHasObjectBeenCompletelyDestroyed(p0: number): boolean

getIsArticulatedJointAtMaxAngle ​

ts
getIsArticulatedJointAtMaxAngle(p0: number, p1: number): boolean

getIsArticulatedJointAtMinAngle ​

ts
getIsArticulatedJointAtMinAngle(object: number, p1: number): boolean

getObjectFragmentDamageHealth ​

ts
getObjectFragmentDamageHealth(p0: number, p1: boolean): number

getObjectTintIndex ​

ts
getObjectTintIndex(object: number): number

getOffsetFromCoordAndHeadingInWorldCoords ​

ts
getOffsetFromCoordAndHeadingInWorldCoords(xpos: number, ypos: number, zpos: number, heading: number, xoffset: number, yoffset: number, zoffset: number): { x: number; y: number; z: number }

getPickupCoords ​

ts
getPickupCoords(pickup: number): { x: number; y: number; z: number }

getPickupGenerationRangeMultiplier ​

ts
getPickupGenerationRangeMultiplier(): number

getPickupObject ​

ts
getPickupObject(pickup: number): number

getPickupTypeFromWeaponHash ​

ts
getPickupTypeFromWeaponHash(weaponhash: number): number

getRayfireMapObject ​

ts
getRayfireMapObject(x: number, y: number, z: number, radius: number, name: string): number

getRayfireMapObjectAnimPhase ​

ts
getRayfireMapObjectAnimPhase(object: number): number

getSafePickupCoords ​

ts
getSafePickupCoords(x: number, y: number, z: number, p3: number, p4: number): { x: number; y: number; z: number }

getStateOfClosestDoorOfType ​

ts
getStateOfClosestDoorOfType(type: number, x: number, y: number, z: number): { heading: number; locked: boolean }

getStateOfRayfireMapObject ​

ts
getStateOfRayfireMapObject(object: number): number

getWeaponTypeFromPickupType ​

ts
getWeaponTypeFromPickupType(pickuphash: number): number

hasClosestObjectOfTypeBeenBroken ​

ts
hasClosestObjectOfTypeBeenBroken(p0: number, p1: number, p2: number, p3: number, modelhash: number, p5: number): boolean

hasClosestObjectOfTypeBeenCompletelyDestroyed ​

ts
hasClosestObjectOfTypeBeenCompletelyDestroyed(x: number, y: number, z: number, radius: number, modelhash: number, p5: boolean): boolean

hasObjectBeenBroken ​

ts
hasObjectBeenBroken(object: number, p1: number): boolean

hasPickupBeenCollected ​

ts
hasPickupBeenCollected(pickup: number): boolean

hidePortablePickupWhenDetached ​

ts
hidePortablePickupWhenDetached(pickupobject: number, toggle: boolean): void

isAnyEntityEntirelyInsideGarage ​

ts
isAnyEntityEntirelyInsideGarage(garagehash: number, p1: boolean, p2: boolean, p3: boolean, p4: number): boolean

isAnyObjectNearPoint ​

ts
isAnyObjectNearPoint(x: number, y: number, z: number, range: number, p4: boolean): boolean

isDoorClosed ​

ts
isDoorClosed(doorhash: number): boolean

isDoorRegisteredWithSystem ​

ts
isDoorRegisteredWithSystem(doorhash: number): boolean

isGarageEmpty ​

ts
isGarageEmpty(garagehash: number, p1: boolean, p2: number): boolean

isObjectAPickup ​

ts
isObjectAPickup(object: number): boolean

isObjectAPortablePickup ​

ts
isObjectAPortablePickup(object: number): boolean

isObjectEntirelyInsideGarage ​

ts
isObjectEntirelyInsideGarage(garagehash: number, entity: number, p2: number, p3: number): boolean

isObjectNearPoint ​

ts
isObjectNearPoint(objecthash: number, x: number, y: number, z: number, range: number): boolean

isObjectPartiallyInsideGarage ​

ts
isObjectPartiallyInsideGarage(garagehash: number, entity: number, p2: number): boolean

isObjectVisible ​

ts
isObjectVisible(object: number): boolean

isPickupWeaponObjectValid ​

ts
isPickupWeaponObjectValid(object: number): boolean

isPlayerEntirelyInsideGarage ​

ts
isPlayerEntirelyInsideGarage(garagehash: number, player: number, p2: number, p3: number): boolean

isPlayerPartiallyInsideGarage ​

ts
isPlayerPartiallyInsideGarage(garagehash: number, player: number, p2: number): boolean

isPointInAngledArea ​

ts
isPointInAngledArea(xpos: number, ypos: number, zpos: number, x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, width: number, debug: boolean, includez: boolean): boolean

isPropLightOverriden ​

ts
isPropLightOverriden(object: number): boolean

onlyCleanUpObjectWhenOutOfRange ​

ts
onlyCleanUpObjectWhenOutOfRange(object: number): void

openAllBarriersForRace ​

ts
openAllBarriersForRace(p0: boolean): void

placeObjectOnGroundOrObjectProperly ​

ts
placeObjectOnGroundOrObjectProperly(object: number): boolean

placeObjectOnGroundProperly ​

ts
placeObjectOnGroundProperly(object: number): boolean

playObjectAutoStartAnim ​

ts
playObjectAutoStartAnim(p0: number): void

preventCollectionOfPortablePickup ​

ts
preventCollectionOfPortablePickup(object: number, p1: boolean, p2: boolean): void

removeAllPickupsOfType ​

ts
removeAllPickupsOfType(pickuphash: number): void

removeDoorFromSystem ​

ts
removeDoorFromSystem(doorhash: number, p1: number): void

removeObjectHighDetailModel ​

ts
removeObjectHighDetailModel(object: number): void

removePickup ​

ts
removePickup(pickup: number): void

renderFakePickupGlow ​

ts
renderFakePickupGlow(x: number, y: number, z: number, colorindex: number): void

rotateObject ​

ts
rotateObject(object: number, p1: number, p2: number, p3: boolean): boolean

setActivateObjectPhysicsAsSoonAsItIsUnfrozen ​

ts
setActivateObjectPhysicsAsSoonAsItIsUnfrozen(object: number, toggle: boolean): void

setCustomPickupWeaponHash ​

ts
setCustomPickupWeaponHash(pickuphash: number, pickup: number): void

setCutscenesWeaponFlashlightOnThisFrame ​

ts
setCutscenesWeaponFlashlightOnThisFrame(object: number, toggle: boolean): void

setDisableCollisionsBetweenCarsAndCarParachute ​

ts
setDisableCollisionsBetweenCarsAndCarParachute(p0: number): void

setDriveArticulatedJoint ​

ts
setDriveArticulatedJoint(object: number, toggle: boolean, p2: number): void

setDriveArticulatedJointWithInflictor ​

ts
setDriveArticulatedJointWithInflictor(object: number, toggle: boolean, p2: number, ped: number): void

setEntityFlagRenderSmallShadow ​

ts
setEntityFlagRenderSmallShadow(object: number, toggle: boolean): void

setEntityFlagSuppressShadow ​

ts
setEntityFlagSuppressShadow(entity: number, toggle: boolean): void

setForceObjectThisFrame ​

ts
setForceObjectThisFrame(x: number, y: number, z: number, p3: number): void

setIsObjectArticulated ​

ts
setIsObjectArticulated(object: number, toggle: boolean): void

setIsObjectBall ​

ts
setIsObjectBall(object: number, toggle: boolean): void

setLocalPlayerCanCollectPortablePickups ​

ts
setLocalPlayerCanCollectPortablePickups(toggle: boolean): void

setLocalPlayerPermittedToCollectPickupsWithModel ​

ts
setLocalPlayerPermittedToCollectPickupsWithModel(modelhash: number, toggle: boolean): void

setLockedUnstreamedInDoorOfType ​

ts
setLockedUnstreamedInDoorOfType(modelhash: number, x: number, y: number, z: number, locked: boolean, xrotmult: number, yrotmult: number, zrotmult: number): void

setMaxNumPortablePickupsCarriedByPlayer ​

ts
setMaxNumPortablePickupsCarriedByPlayer(modelhash: number, number: number): void

setObjectAllowLowLodBuoyancy ​

ts
setObjectAllowLowLodBuoyancy(object: number, toggle: boolean): void

setObjectForceVehiclesToAvoid ​

ts
setObjectForceVehiclesToAvoid(object: number, toggle: boolean): void

setObjectGlowInSameTeam ​

ts
setObjectGlowInSameTeam(pickup: number): void

setObjectIsAPressurePlate ​

ts
setObjectIsAPressurePlate(object: number, toggle: boolean): void

setObjectIsSpecialGolfball ​

ts
setObjectIsSpecialGolfball(object: number, toggle: boolean): void

setObjectIsVisibleInMirrors ​

ts
setObjectIsVisibleInMirrors(object: number, toggle: boolean): void

setObjectPhysicsParams ​

ts
setObjectPhysicsParams(object: number, weight: number, p2: number, p3: number, p4: number, p5: number, gravity: number, p7: number, p8: number, p9: number, p10: number, buoyancy: number): void

setObjectSpeedBoostAmount ​

ts
setObjectSpeedBoostAmount(object: number, p1: number): void

setObjectSpeedBoostDuration ​

ts
setObjectSpeedBoostDuration(object: number, duration: number): void

setObjectTakesDamageFromCollidingWithBuildings ​

ts
setObjectTakesDamageFromCollidingWithBuildings(p0: number, p1: boolean): void

setObjectTargettable ​

ts
setObjectTargettable(object: number, targettable: boolean, p2: number): void

setObjectTintIndex ​

ts
setObjectTintIndex(object: number, texturevariation: number): void

setOnlyAllowAmmoCollectionWhenLow ​

ts
setOnlyAllowAmmoCollectionWhenLow(p0: boolean): void

setPickupGenerationRangeMultiplier ​

ts
setPickupGenerationRangeMultiplier(multiplier: number): void

setPickupGlowOffset ​

ts
setPickupGlowOffset(pickup: number, p1: number): void

setPickupHiddenWhenUncollectable ​

ts
setPickupHiddenWhenUncollectable(pickup: number, toggle: boolean): void

setPickupObjectAlphaWhenTransparent ​

ts
setPickupObjectAlphaWhenTransparent(p0: number): void

setPickupObjectArrowMarker ​

ts
setPickupObjectArrowMarker(pickup: number, toggle: boolean): void

setPickupObjectCollectableInVehicle ​

ts
setPickupObjectCollectableInVehicle(pickup: number): void

setPickupObjectGlowOffset ​

ts
setPickupObjectGlowOffset(pickup: number, p1: number, p2: boolean): void

setPickupObjectGlowWhenUncollectable ​

ts
setPickupObjectGlowWhenUncollectable(pickup: number, toggle: boolean): void

setPickupObjectTransparentWhenUncollectable ​

ts
setPickupObjectTransparentWhenUncollectable(pickup: number, toggle: boolean): void

setPickupRegenerationTime ​

ts
setPickupRegenerationTime(pickup: number, duration: number): void

setPickupTrackDamageEvents ​

ts
setPickupTrackDamageEvents(pickup: number, toggle: boolean): void

setPickupTransparentWhenUncollectable ​

ts
setPickupTransparentWhenUncollectable(pickup: number, toggle: boolean): void

setPickupUncollectable ​

ts
setPickupUncollectable(pickup: number, toggle: boolean): void

setPlayerPermittedToCollectPickupsOfType ​

ts
setPlayerPermittedToCollectPickupsOfType(player: number, pickuphash: number, toggle: boolean): void

setPortablePickupPersist ​

ts
setPortablePickupPersist(pickup: number, toggle: boolean): void

setProjectilesShouldExplodeOnContact ​

ts
setProjectilesShouldExplodeOnContact(entity: number, p1: number): void

setPropLightColor ​

ts
setPropLightColor(object: number, p1: boolean, r: number, g: number, b: number): boolean

setPropTintIndex ​

ts
setPropTintIndex(p0: number, p1: number): void

setStateOfClosestDoorOfType ​

ts
setStateOfClosestDoorOfType(type: number, x: number, y: number, z: number, locked: boolean, heading: number, p6: boolean): void

setStateOfRayfireMapObject ​

ts
setStateOfRayfireMapObject(object: number, state: number): void

setTeamPickupObject ​

ts
setTeamPickupObject(object: number, p1: number, p2: boolean): void

setTintIndexClosestBuildingOfType ​

ts
setTintIndexClosestBuildingOfType(x: number, y: number, z: number, radius: number, modelhash: number, texturevariation: number): boolean

setWeaponImpactsApplyGreaterForce ​

ts
setWeaponImpactsApplyGreaterForce(object: number, p1: boolean): void

slideObject ​

ts
slideObject(object: number, tox: number, toy: number, toz: number, speedx: number, speedy: number, speedz: number, collision: boolean): boolean

suppressPickupRewardType ​

ts
suppressPickupRewardType(rewardtype: number, suppress: boolean): void

suppressPickupSoundForPickup ​

ts
suppressPickupSoundForPickup(p0: number, p1: number): void

trackObjectVisibility ​

ts
trackObjectVisibility(object: number): void

VIMP developer documentation