PedInventory Class

RAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:Rage.PedInventory"]

Inheritance Hierarchy
SystemObject
  RagePedInventory

Namespace:  Rage
Assembly:  RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
Syntax
Copy
public sealed class PedInventory

The PedInventory type exposes the following members.

Properties
  NameDescription
Public propertyEquippedWeapon

Gets the weapon currently equipped by the owning Ped.

Public propertyEquippedWeaponObject

Gets the object representing this weapon in the world.

Only weapons in the game world, and equipped by Peds have an object. Holstered weapons do not.

Public propertyHasFlashlight
Gets a value indicating whether this inventory has a flashlight.
Public propertyHasLoadedWeapon
Gets a value indicating whether this inventory contains a loaded weapon.
Public propertyHasParachute
Gets a value indicating whether this inventory has a parachute.
Public propertyPed
Gets the owning Ped of this inventory.
Public propertyWeapons

Gets a collection of all the weapons currently in this inventory.

Top
Methods
  NameDescription
Public methodAddComponentToWeapon

Gives the specified weapon component to the specified weapon belonging to this Ped.

The Ped must own the specified weapon to receive the component.

The weapon asset can be one of the following:

NameDescription
WEAPON_UNARMEDWEAPON_UNARMED
WEAPON_ANIMALWEAPON_ANIMAL
WEAPON_COUGARWEAPON_COUGAR
WEAPON_KNIFEWEAPON_KNIFE
WEAPON_NIGHTSTICKWEAPON_NIGHTSTICK
WEAPON_HAMMERWEAPON_HAMMER
WEAPON_BATWEAPON_BAT
WEAPON_GOLFCLUBWEAPON_GOLFCLUB
WEAPON_CROWBARWEAPON_CROWBAR
WEAPON_PISTOLWEAPON_PISTOL
WEAPON_COMBATPISTOLWEAPON_COMBATPISTOL
WEAPON_APPISTOLWEAPON_APPISTOL
WEAPON_PISTOL50WEAPON_PISTOL50
WEAPON_MICROSMGWEAPON_MICROSMG
WEAPON_SMGWEAPON_SMG
WEAPON_ASSAULTSMGWEAPON_ASSAULTSMG
WEAPON_ASSAULTRIFLEWEAPON_ASSAULTRIFLE
WEAPON_CARBINERIFLEWEAPON_CARBINERIFLE
WEAPON_ADVANCEDRIFLEWEAPON_ADVANCEDRIFLE
WEAPON_MGWEAPON_MG
WEAPON_COMBATMGWEAPON_COMBATMG
WEAPON_PUMPSHOTGUNWEAPON_PUMPSHOTGUN
WEAPON_SAWNOFFSHOTGUNWEAPON_SAWNOFFSHOTGUN
WEAPON_ASSAULTSHOTGUNWEAPON_ASSAULTSHOTGUN
WEAPON_BULLPUPSHOTGUNWEAPON_BULLPUPSHOTGUN
WEAPON_STUNGUNWEAPON_STUNGUN
WEAPON_SNIPERRIFLEWEAPON_SNIPERRIFLE
WEAPON_HEAVYSNIPERWEAPON_HEAVYSNIPER
WEAPON_REMOTESNIPERWEAPON_REMOTESNIPER
WEAPON_GRENADELAUNCHERWEAPON_GRENADELAUNCHER
WEAPON_GRENADELAUNCHER_SMOKEWEAPON_GRENADELAUNCHER_SMOKE
WEAPON_RPGWEAPON_RPG
WEAPON_PASSENGER_ROCKETWEAPON_PASSENGER_ROCKET
WEAPON_AIRSTRIKE_ROCKETWEAPON_AIRSTRIKE_ROCKET
WEAPON_STINGERWEAPON_STINGER
WEAPON_MINIGUNWEAPON_MINIGUN
WEAPON_GRENADEWEAPON_GRENADE
WEAPON_STICKYBOMBWEAPON_STICKYBOMB
WEAPON_SMOKEGRENADEWEAPON_SMOKEGRENADE
WEAPON_BZGASWEAPON_BZGAS
WEAPON_MOLOTOVWEAPON_MOLOTOV
WEAPON_FIREEXTINGUISHERWEAPON_FIREEXTINGUISHER
WEAPON_PETROLCANWEAPON_PETROLCAN
WEAPON_DIGISCANNERWEAPON_DIGISCANNER
WEAPON_BRIEFCASEWEAPON_BRIEFCASE
WEAPON_BRIEFCASE_02WEAPON_BRIEFCASE_02
WEAPON_BALLWEAPON_BALL
WEAPON_FLAREWEAPON_FLARE
WEAPON_VEHICLE_ROCKETWEAPON_VEHICLE_ROCKET
WEAPON_BARBED_WIREWEAPON_BARBED_WIRE
WEAPON_DROWNINGWEAPON_DROWNING
WEAPON_DROWNING_IN_VEHICLEWEAPON_DROWNING_IN_VEHICLE
WEAPON_BLEEDINGWEAPON_BLEEDING
WEAPON_ELECTRIC_FENCEWEAPON_ELECTRIC_FENCE
WEAPON_EXPLOSIONWEAPON_EXPLOSION
WEAPON_FALLWEAPON_FALL
WEAPON_EXHAUSTIONWEAPON_EXHAUSTION
WEAPON_HIT_BY_WATER_CANNONWEAPON_HIT_BY_WATER_CANNON
WEAPON_RAMMED_BY_CARWEAPON_RAMMED_BY_CAR
WEAPON_RUN_OVER_BY_CARWEAPON_RUN_OVER_BY_CAR
WEAPON_HELI_CRASHWEAPON_HELI_CRASH
WEAPON_FIREWEAPON_FIRE
WEAPON_ANIMAL_RETRIEVERWEAPON_ANIMAL_RETRIEVER
WEAPON_SMALL_DOGWEAPON_SMALL_DOG
WEAPON_TIGER_SHARKWEAPON_TIGER_SHARK
WEAPON_HAMMERHEAD_SHARKWEAPON_HAMMERHEAD_SHARK
WEAPON_KILLER_WHALEWEAPON_KILLER_WHALE
WEAPON_BOARWEAPON_BOAR
WEAPON_PIGWEAPON_PIG
WEAPON_COYOTEWEAPON_COYOTE
WEAPON_DEERWEAPON_DEER
WEAPON_HENWEAPON_HEN
WEAPON_RABBITWEAPON_RABBIT
WEAPON_CATWEAPON_CAT
WEAPON_COWWEAPON_COW
WEAPON_BIRD_CRAPWEAPON_BIRD_CRAP

The component name can be one of the following:

NameDescription
COMPONENT_AT_RAILCOVER_01COMPONENT_AT_RAILCOVER_01
COMPONENT_AT_AR_AFGRIPCOMPONENT_AT_AR_AFGRIP
COMPONENT_AT_PI_FLSHCOMPONENT_AT_PI_FLSH
COMPONENT_AT_AR_FLSHCOMPONENT_AT_AR_FLSH
COMPONENT_AT_SCOPE_MACROCOMPONENT_AT_SCOPE_MACRO
COMPONENT_AT_SCOPE_SMALLCOMPONENT_AT_SCOPE_SMALL
COMPONENT_AT_SCOPE_MEDIUMCOMPONENT_AT_SCOPE_MEDIUM
COMPONENT_AT_SCOPE_LARGECOMPONENT_AT_SCOPE_LARGE
COMPONENT_AT_SCOPE_MAXCOMPONENT_AT_SCOPE_MAX
COMPONENT_AT_PI_SUPPCOMPONENT_AT_PI_SUPP
COMPONENT_AT_AR_SUPPCOMPONENT_AT_AR_SUPP
COMPONENT_AT_AR_SUPP_02COMPONENT_AT_AR_SUPP_02
COMPONENT_AT_SR_SUPPCOMPONENT_AT_SR_SUPP
COMPONENT_PISTOL_CLIP_01COMPONENT_PISTOL_CLIP_01
COMPONENT_PISTOL_CLIP_02COMPONENT_PISTOL_CLIP_02
COMPONENT_COMBATPISTOL_CLIP_01COMPONENT_COMBATPISTOL_CLIP_01
COMPONENT_COMBATPISTOL_CLIP_02COMPONENT_COMBATPISTOL_CLIP_02
COMPONENT_APPISTOL_CLIP_01COMPONENT_APPISTOL_CLIP_01
COMPONENT_APPISTOL_CLIP_02COMPONENT_APPISTOL_CLIP_02
COMPONENT_MICROSMG_CLIP_01COMPONENT_MICROSMG_CLIP_01
COMPONENT_MICROSMG_CLIP_02COMPONENT_MICROSMG_CLIP_02
COMPONENT_SMG_CLIP_01COMPONENT_SMG_CLIP_01
COMPONENT_SMG_CLIP_02COMPONENT_SMG_CLIP_02
COMPONENT_ASSAULTRIFLE_CLIP_01COMPONENT_ASSAULTRIFLE_CLIP_01
COMPONENT_ASSAULTRIFLE_CLIP_02COMPONENT_ASSAULTRIFLE_CLIP_02
COMPONENT_CARBINERIFLE_CLIP_01COMPONENT_CARBINERIFLE_CLIP_01
COMPONENT_CARBINERIFLE_CLIP_02COMPONENT_CARBINERIFLE_CLIP_02
COMPONENT_ADVANCEDRIFLE_CLIP_01COMPONENT_ADVANCEDRIFLE_CLIP_01
COMPONENT_ADVANCEDRIFLE_CLIP_02COMPONENT_ADVANCEDRIFLE_CLIP_02
COMPONENT_MG_CLIP_01COMPONENT_MG_CLIP_01
COMPONENT_MG_CLIP_02COMPONENT_MG_CLIP_02
COMPONENT_COMBATMG_CLIP_01COMPONENT_COMBATMG_CLIP_01
COMPONENT_COMBATMG_CLIP_02COMPONENT_COMBATMG_CLIP_02
COMPONENT_PUMPSHOTGUN_CLIP_01COMPONENT_PUMPSHOTGUN_CLIP_01
COMPONENT_SAWNOFFSHOTGUN_CLIP_01COMPONENT_SAWNOFFSHOTGUN_CLIP_01
COMPONENT_ASSAULTSHOTGUN_CLIP_01COMPONENT_ASSAULTSHOTGUN_CLIP_01
COMPONENT_ASSAULTSHOTGUN_CLIP_02COMPONENT_ASSAULTSHOTGUN_CLIP_02
COMPONENT_SNIPERRIFLE_CLIP_01COMPONENT_SNIPERRIFLE_CLIP_01
COMPONENT_HEAVYSNIPER_CLIP_01COMPONENT_HEAVYSNIPER_CLIP_01
COMPONENT_MINIGUN_CLIP_01COMPONENT_MINIGUN_CLIP_01
COMPONENT_RPG_CLIP_01COMPONENT_RPG_CLIP_01
COMPONENT_GRENADELAUNCHER_CLIP_01COMPONENT_GRENADELAUNCHER_CLIP_01
COMPONENT_PISTOL50_CLIP_01COMPONENT_PISTOL50_CLIP_01
COMPONENT_PISTOL50_CLIP_02COMPONENT_PISTOL50_CLIP_02
COMPONENT_ASSAULTSMG_CLIP_01COMPONENT_ASSAULTSMG_CLIP_01
COMPONENT_ASSAULTSMG_CLIP_02COMPONENT_ASSAULTSMG_CLIP_02
COMPONENT_BULLPUPSHOTGUN_CLIP_01COMPONENT_BULLPUPSHOTGUN_CLIP_01
Public methodGiveFlashlight
Ensures the owning Ped has a flashlight.
Public methodGiveNewWeapon(WeaponAsset, Int16, Boolean)
Public methodGiveNewWeapon(WeaponDescriptor, Int16, Boolean)
Public methodGiveNewWeapon(WeaponHash, Int16, Boolean)
Public methodGiveParachute
Public methodRemoveFlashlight
Public methodRemoveParachute
Top
See Also

Reference

Rage Namespace