Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Ped

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Ped(handle: number): Ped

Properties

Private attributes

attributes: undefined | Attributes

Accessors

Accuracy

  • get Accuracy(): number
  • set Accuracy(accuracy: number): void

Attributes

CanBeKnockedOffVehicle

  • get CanBeKnockedOffVehicle(): boolean

CanBeTargeted

  • set CanBeTargeted(toggle: boolean): void

CrouchMovement

  • get CrouchMovement(): boolean

DamageCleanliness

DefenseModifier

  • set DefenseModifier(amount: number): void

Handle

  • get Handle(): number

Heading

  • get Heading(): number
  • set Heading(heading: number): void

Health

  • get Health(): number
  • set Health(amount: number): void

HearingRange

  • set HearingRange(value: number): void

InVehicle

  • get InVehicle(): boolean

IsBeingJacked

  • get IsBeingJacked(): boolean

IsClimbing

  • get IsClimbing(): boolean

IsClimbingLadder

  • get IsClimbingLadder(): boolean

IsDamaged

  • get IsDamaged(): boolean
  • set IsDamaged(damaged: boolean): void

IsDiving

  • get IsDiving(): boolean

IsFalling

  • get IsFalling(): boolean

IsFatallyInjured

  • get IsFatallyInjured(): boolean

IsHuman

  • get IsHuman(): boolean

IsInAnyBoat

  • get IsInAnyBoat(): boolean

IsInAnyHeli

  • get IsInAnyHeli(): boolean

IsInAnyPlane

  • get IsInAnyPlane(): boolean

IsInCombatRoll

  • get IsInCombatRoll(): boolean

IsInFlyingVehicle

  • get IsInFlyingVehicle(): boolean

IsInjured

  • get IsInjured(): boolean

IsInteractingWithAnimal

  • get IsInteractingWithAnimal(): boolean

IsJacking

  • get IsJacking(): boolean

IsJumping

  • get IsJumping(): boolean

IsMale

  • get IsMale(): boolean

IsOnTopOfVehicle

  • get IsOnTopOfVehicle(): boolean

IsOpeningADoor

  • get IsOpeningADoor(): boolean

IsPlantingBomb

  • get IsPlantingBomb(): boolean

IsPlayer

  • get IsPlayer(): boolean

IsShooting

  • get IsShooting(): boolean

IsSittingInAnyVehicle

  • get IsSittingInAnyVehicle(): boolean

IsSliding

  • get IsSliding(): boolean

IsStealthed

  • get IsStealthed(): boolean

IsStunned

  • get IsStunned(): boolean

IsVaulting

  • get IsVaulting(): boolean

LeadingHorse

  • get LeadingHorse(): Ped

MaxHealth

  • get MaxHealth(): number
  • set MaxHealth(amount: number): void

  • While this increases the peds max health, if used on a player it wont increase the max core value on the hud

    Returns number

  • While this increases the peds max health, if used on a player it wont increase the max core value on the hud

    Parameters

    • amount: number

    Returns void

Mount

  • get Mount(): Ped

Owner

  • get Owner(): Ped

SeeingRange

  • set SeeingRange(value: number): void

TamingState

Vehicle

Methods

canBeTargetedByPlayer

  • canBeTargetedByPlayer(player: Player, toggle: boolean): void

clearLastBoneDamage

  • clearLastBoneDamage(): void

clone

  • clone(network: boolean, bScriptHostPed: boolean, copyHeadBlend: boolean): Ped

  • creates a clone of the ped

    Parameters

    • network: boolean

      if the ped should be a networked entity

    • bScriptHostPed: boolean

      whether to register the ped as pinned to the script host in the R* network model.

    • copyHeadBlend: boolean

      whether to copy the peds head blend

    Returns Ped

    the cloned ped

cloneTo

  • cloneTo(targetPed: Ped): void

  • clones the ped onto the target ped

    Parameters

    • targetPed: Ped

      the ped to clone onto

    Returns void

damage

  • damage(amount: number, boneId?: number, killer?: Ped): void

  • Parameters

    • amount: number
    • boneId: number = 0
    • Optional killer: Ped

    Returns void

delete

  • delete(): void

  • Removes the specified ped if its not a player entity

    Returns void

getJacker

  • getJacker(): Ped

isInteractionPossible

  • isInteractionPossible(animal: Ped): boolean

isOnVehicle

  • isOnVehicle(vehicle: Vehicle): boolean

isSeatFree

  • Parameters

    Returns boolean

    true of the specified seat is free on the mount

isSittingInVehicle

  • isSittingInVehicle(vehicle: Vehicle): boolean

killPed

  • killPed(killer?: Entity): void

  • kills the ped and optionally sets the killer

    Parameters

    • Optional killer: Entity

      the entity that killed the ped

    Returns void

removeFromMount

  • removeFromMount(): void

setCanBeKnockedOffVehicle

  • this returns a different type then the getter so we can't use set, maybe ts will fix soon (tm)

    Parameters

    • state: KnockOffVehicle

      how hard it will be to knock a ped off their vehicle

    Returns void

setCrouchMovement

  • setCrouchMovement(state: boolean, immediately?: boolean): void

  • Parameters

    • state: boolean
    • immediately: boolean = false

    Returns void

setIntoVehicle

  • Sets the ped into the specified vehicle

    Parameters

    • vehicle: Vehicle

      the vehicle to put the ped into

    • seatIndex: VehicleSeat

      the seat index to put the ped into

    Returns void

setOntoMount

  • puts the ped onto the specified mount

    Parameters

    • targetPed: Ped

      the horse to put the ped on

    • seatIndex: VehicleSeat

      the seat index to put the ped on

    Returns void

setOwnsAnimal

  • setOwnsAnimal(animal: Ped): void

warpOutOfVehicle

  • warpOutOfVehicle(): void

Static blockScenariosInArea

  • blockScenariosInArea(vec1: Vector3, vec2: Vector3, blockingFlags: number): number

  • Blocks scenarios inbetween the specified vectors

    todo

    Move to Game

    Parameters

    Returns number

    the scenarioId that can be used in removeScenarioBlock to unblock

Static removeScenarioBlock

  • removeScenarioBlock(scenarioId: number): void

Generated using TypeDoc