Ped Data
The PedData
class represents a comprehensive data record associated with a specific Rage.Ped
. It encapsulates various attributes, characteristics, and personal information about the ped.
Properties
Holder
This property is read-only.
The Rage.Ped
instance to which this PedData
record belongs.
public readonly Ped Holder;
HasRealPed
This property is read-only.
Indicates whether this PedData
instance is currently associated with an actual Rage.Ped
that exists or has existed.
True if the Holder
property is not null
. Otherwise, false.
public bool HasRealPed;
DriversLicenseExpiration
Gets or sets the expiration date of the ped's driver's license. If the ped does not possess a driver's license or it's otherwise not applicable
This value may be null.
public DateTime? DriversLicenseExpiration;
Address
Gets or sets the residential address associated with the ped.
public PedAddress Address;
- Type:
CommonDataFramework.Modules.PedResidence.PedAddress
- See Also:
PedAddress
class
DriversLicenseState
Gets or sets the current state of the ped's driver's license. Modifying this property also influences the DriversLicenseExpiration
date based on the new state.
public ELicenseState DriversLicenseState;
Firstname
Gets or sets the first name of the ped.
public string Firstname;
Lastname
Gets or sets the last name of the ped.
public string Lastname;
FullName
This property is read-only.
Returns the full name of the ped, combining their first and last names.
public string FullName;
Birthday
Gets or sets the birthdate of the ped.
public DateTime Birthday;
Citations
Gets or sets the total number of citations (e.g., traffic tickets) the ped has received.
public int Citations;
TimesStopped
Gets or sets the total number of times the ped has been stopped.
public int TimesStopped;
Gender
Gets or sets the gender of the ped.
public Gender Gender;
- Type:
LSPD_First_Response.Engine.Scripting.Entities.Gender
Wanted
Gets or sets a boolean value indicating whether the ped is currently wanted by law enforcement.
public bool Wanted;
AdvisoryText
Gets or sets any advisory text associated with this ped, which might contain important notes or warnings.
public string AdvisoryText;
ModelAge
This property is read-only.
Gets the age category of the ped's model.
public PedModelAge ModelAge;
- Type:
LSPD_First_Response.Engine.Scripting.Entities.PedModelAge
RuntimeInfo
Gets or sets runtime-specific information associated with the ped.
public RuntimePersonaInformation RuntimeInfo;
- Type:
LSPD_First_Response.Engine.Scripting.Entities.RuntimePersonaInformation
WantedInfo
This property is read-only.
Gets comprehensive information regarding the ped's wanted status, including details about active warrants.
public WantedInformation WantedInfo;
- Type:
LSPD_First_Response.Engine.Scripting.Entities.WantedInformation
IsOnParole
Gets or sets a boolean value indicating whether the ped is currently on parole.
public bool IsOnParole;
IsOnProbation
Gets or sets a boolean value indicating whether the ped is currently on probation.
public bool IsOnProbation;
HuntingPermit
This field is read-only.
Represents the ped's hunting permit details.
public readonly Permit HuntingPermit;
- Type:
CommonDataFramework.Modules.PedDatabase.Permit
- See Also: Permit class
FishingPermit
This field is read-only.
Represents the ped's fishing permit details.
public readonly Permit FishingPermit;
- Type:
CommonDataFramework.Modules.PedDatabase.Permit
- See Also: Permit class
WeaponPermit
This field is read-only.
Represents the ped's weapon permit details.
public readonly WeaponPermit WeaponPermit;
- Type:
CommonDataFramework.Modules.PedDatabase.WeaponPermit
- See Also: WeaponPermit class
Methods
ToNameAndDOBString()
Combines the full name and birthday of this ped's data into a single string.
public string ToNameAndDOBString();
- Returns: A string containing the ped's full name and date of birth.
GetPedData(this Ped ped)
This method is technically under PedDataController
. Not PedData
This static extension method, provides a convenient way to retrieve or initialize a PedData
record for a specified Rage.Ped
instance.
public static PedData GetPedData(this Ped ped);
- Returns: A PedData object of the ped specified.
This method returns null
under the following conditions:
- If the provided
ped
is not a human character (!ped.IsHuman
) - If
PedData
was requested for a non-existent ped and no previous data was stored for it in the database.
Otherwise, if PedData
already exists for the ped
, it will be returned from the cache. If it does not exist but the ped
is valid and human, a new PedData
instance will be created and returned.