Index

Search Results for

    Interface IPlayer

    Inherited Members
    AltV.Net.Shared.Elements.Entities.ISharedBaseObject.SetMetaData(Dictionary<, >)
    Namespace: AltV.Net.Elements.Entities
    Assembly: AltV.Net.dll
    Syntax
    public interface IPlayer : ISharedPlayer, IEntity, ISharedEntity, IWorldObject, ISharedWorldObject, IBaseObject, ISharedBaseObject, INative

    Properties

    | Improve this Doc View Source

    Armor

    Sets and returns the players current armor

    Declaration
    ushort Armor { get; set; }
    Property Value
    Type Description
    System.UInt16
    | Improve this Doc View Source

    AuthToken

    Declaration
    string AuthToken { get; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    BloodDamage

    Declaration
    string BloodDamage { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    CloudAuthResult

    Declaration
    CloudAuthResult CloudAuthResult { get; }
    Property Value
    Type Description
    CloudAuthResult
    | Improve this Doc View Source

    CloudId

    Declaration
    string CloudId { get; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    CurrentWeapon

    Returns the current weapon the player has equipped

    Declaration
    uint CurrentWeapon { get; set; }
    Property Value
    Type Description
    System.UInt32
    | Improve this Doc View Source

    DiscordId

    Declaration
    long DiscordId { get; }
    Property Value
    Type Description
    System.Int64
    | Improve this Doc View Source

    EntityAimingAt

    Returns the IEntity object if the player is aiming at

    Declaration
    IEntity EntityAimingAt { get; }
    Property Value
    Type Description
    IEntity
    | Improve this Doc View Source

    EyeColor

    Get Eye Color

    Declaration
    ushort EyeColor { get; }
    Property Value
    Type Description
    System.UInt16
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    HairColor

    Get/Set Hair Color

    Declaration
    byte HairColor { get; set; }
    Property Value
    Type Description
    System.Byte
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    HairHighlightColor

    Get/Set Hair Highlight Color

    Declaration
    byte HairHighlightColor { get; set; }
    Property Value
    Type Description
    System.Byte
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    HardwareIdExHash

    Declaration
    ulong HardwareIdExHash { get; }
    Property Value
    Type Description
    System.UInt64
    | Improve this Doc View Source

    HardwareIdHash

    Returns the players Hardware ID Hash

    Declaration
    ulong HardwareIdHash { get; }
    Property Value
    Type Description
    System.UInt64
    | Improve this Doc View Source

    HeadBlendData

    Get Head Blend Data

    Declaration
    HeadBlendData HeadBlendData { get; }
    Property Value
    Type Description
    HeadBlendData
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    Health

    Gets and Sets the players health

    Declaration
    ushort Health { get; set; }
    Property Value
    Type Description
    System.UInt16
    | Improve this Doc View Source

    InteriorLocation

    Declaration
    uint InteriorLocation { get; }
    Property Value
    Type Description
    System.UInt32
    | Improve this Doc View Source

    Invincible

    Get or set if the player is invincible.

    Declaration
    bool Invincible { get; set; }
    Property Value
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    Ip

    Returns the IP of the player

    Declaration
    string Ip { get; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    IsConnected

    Returns true if player is connected - false if not connected

    Declaration
    bool IsConnected { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    IsCrouching

    Gets if the player is crouching.

    Declaration
    bool IsCrouching { get; }
    Property Value
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    IsJumping

    Returns if the player is jumping. True = player jumping

    Declaration
    bool IsJumping { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    IsShooting

    Returns if the player is firing.

    Declaration
    bool IsShooting { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    IsStealthy

    Gets if the player is stealthy.

    Declaration
    bool IsStealthy { get; }
    Property Value
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    IsSuperJumpEnabled

    Gets if the player has super jump enabled.

    Declaration
    bool IsSuperJumpEnabled { get; }
    Property Value
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    LastDamagedBodyPart

    Declaration
    uint LastDamagedBodyPart { get; set; }
    Property Value
    Type Description
    System.UInt32
    | Improve this Doc View Source

    MaxArmor

    Sets and returns the max armor for the player

    Declaration
    ushort MaxArmor { get; set; }
    Property Value
    Type Description
    System.UInt16
    | Improve this Doc View Source

    MaxHealth

    Gets and Sets the players max health

    Declaration
    ushort MaxHealth { get; set; }
    Property Value
    Type Description
    System.UInt16
    | Improve this Doc View Source

    Model

    The players model / skin

    Declaration
    uint Model { get; set; }
    Property Value
    Type Description
    System.UInt32
    | Improve this Doc View Source

    Ping

    Returns the current ping of the player

    Declaration
    uint Ping { get; }
    Property Value
    Type Description
    System.UInt32
    | Improve this Doc View Source

    SendNames

    Declaration
    bool SendNames { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    SocialClubId

    Returns the players Social Club ID

    Declaration
    ulong SocialClubId { get; }
    Property Value
    Type Description
    System.UInt64
    | Improve this Doc View Source

    SocialClubName

    Declaration
    string SocialClubName { get; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Vehicle

    Returns the current vehicle. Null if not in a vehicle

    Declaration
    IVehicle Vehicle { get; }
    Property Value
    Type Description
    IVehicle

    Methods

    | Improve this Doc View Source

    AddDecoration(UInt32, UInt32, Byte)

    Declaration
    void AddDecoration(uint collection, uint overlay, byte count = 1)
    Parameters
    Type Name Description
    System.UInt32 collection
    System.UInt32 overlay
    System.Byte count
    | Improve this Doc View Source

    AddWeaponComponent(WeaponModel, UInt32)

    Declaration
    void AddWeaponComponent(WeaponModel weaponModel, uint weaponComponent)
    Parameters
    Type Name Description
    WeaponModel weaponModel
    System.UInt32 weaponComponent
    | Improve this Doc View Source

    AddWeaponComponent(UInt32, UInt32)

    Adds a weapon component to a weapon

    Declaration
    void AddWeaponComponent(uint weapon, uint weaponComponent)
    Parameters
    Type Name Description
    System.UInt32 weapon

    Weapon hash
    System.UInt32 weaponComponent

    Weapon Component hash
    | Improve this Doc View Source

    ClearBloodDamage()

    Clears the blood damage of the player

    Declaration
    void ClearBloodDamage()
    | Improve this Doc View Source

    ClearClothes(Byte)

    Declaration
    bool ClearClothes(byte component)
    Parameters
    Type Name Description
    System.Byte component
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    ClearDecorations()

    Declaration
    void ClearDecorations()
    | Improve this Doc View Source

    ClearProps(Byte)

    Clear the player props

    Declaration
    void ClearProps(byte component)
    Parameters
    Type Name Description
    System.Byte component
    | Improve this Doc View Source

    ClearTasks()

    Declaration
    void ClearTasks()
    | Improve this Doc View Source

    DeleteLocalMetaData(String)

    Declaration
    void DeleteLocalMetaData(string key)
    Parameters
    Type Name Description
    System.String key
    | Improve this Doc View Source

    Despawn()

    Despawns a player

    Declaration
    void Despawn()
    | Improve this Doc View Source

    Emit(String, Object[])

    Triggers client side event for a player

    Declaration
    void Emit(string eventName, params object[] args)
    Parameters
    Type Name Description
    System.String eventName

    Event Trigger
    System.Object[] args

    Parameters
    | Improve this Doc View Source

    EmitRPC(String, Object[])

    Declaration
    ushort EmitRPC(string name, params object[] args)
    Parameters
    Type Name Description
    System.String name
    System.Object[] args
    Returns
    Type Description
    System.UInt16
    | Improve this Doc View Source

    EmitRPCAnswer(UInt16, Object, String)

    Declaration
    void EmitRPCAnswer(ushort answerId, object answer, string error)
    Parameters
    Type Name Description
    System.UInt16 answerId
    System.Object answer
    System.String error
    | Improve this Doc View Source

    EmitUnreliable(String, Object[])

    Triggers client side event for a player

    Declaration
    void EmitUnreliable(string eventName, params object[] args)
    Parameters
    Type Name Description
    System.String eventName

    Event Trigger
    System.Object[] args

    Parameters
    | Improve this Doc View Source

    GetAmmo(UInt32)

    Declaration
    ushort GetAmmo(uint ammoHash)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    Returns
    Type Description
    System.UInt16
    | Improve this Doc View Source

    GetAmmoFlags(UInt32)

    Declaration
    AmmoFlags GetAmmoFlags(uint ammoHash)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    Returns
    Type Description
    AmmoFlags
    | Improve this Doc View Source

    GetAmmoMax(UInt32)

    Declaration
    int GetAmmoMax(uint ammoHash)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    Returns
    Type Description
    System.Int32
    | Improve this Doc View Source

    GetAmmoMax100(UInt32)

    Declaration
    int GetAmmoMax100(uint ammoHash)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    Returns
    Type Description
    System.Int32
    | Improve this Doc View Source

    GetAmmoMax50(UInt32)

    Declaration
    int GetAmmoMax50(uint ammoHash)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    Returns
    Type Description
    System.Int32
    | Improve this Doc View Source

    GetAmmoSpecialType(UInt32)

    Declaration
    AmmoSpecialType GetAmmoSpecialType(uint ammoHash)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    Returns
    Type Description
    AmmoSpecialType
    | Improve this Doc View Source

    GetClothes(Byte)

    Gets the player clothes

    Declaration
    Cloth GetClothes(byte component)
    Parameters
    Type Name Description
    System.Byte component
    Returns
    Type Description
    Cloth
    | Improve this Doc View Source

    GetClothes(Byte, ref Cloth)

    Gets the player clothes

    Declaration
    void GetClothes(byte component, ref Cloth cloth)
    Parameters
    Type Name Description
    System.Byte component
    Cloth cloth
    | Improve this Doc View Source

    GetCurrentWeaponTintIndex()

    Returns weapon tint of current weapon

    Declaration
    byte GetCurrentWeaponTintIndex()
    Returns
    Type Description
    System.Byte
    | Improve this Doc View Source

    GetDecorations()

    Declaration
    Decoration[] GetDecorations()
    Returns
    Type Description
    Decoration[]
    | Improve this Doc View Source

    GetDlcClothes(Byte)

    Gets the player dlc clothes

    Declaration
    DlcCloth GetDlcClothes(byte component)
    Parameters
    Type Name Description
    System.Byte component
    Returns
    Type Description
    DlcCloth
    | Improve this Doc View Source

    GetDlcClothes(Byte, ref DlcCloth)

    Gets the player dlc clothes

    Declaration
    void GetDlcClothes(byte component, ref DlcCloth cloth)
    Parameters
    Type Name Description
    System.Byte component
    DlcCloth cloth
    | Improve this Doc View Source

    GetDlcProps(Byte)

    Gets the player dlc props

    Declaration
    DlcProp GetDlcProps(byte component)
    Parameters
    Type Name Description
    System.Byte component
    Returns
    Type Description
    DlcProp
    | Improve this Doc View Source

    GetDlcProps(Byte, ref DlcProp)

    Gets the player dlc props

    Declaration
    void GetDlcProps(byte component, ref DlcProp prop)
    Parameters
    Type Name Description
    System.Byte component
    DlcProp prop
    | Improve this Doc View Source

    GetFaceFeatureScale(Byte)

    Get Face Feature Scale

    Declaration
    float GetFaceFeatureScale(byte index)
    Parameters
    Type Name Description
    System.Byte index
    Returns
    Type Description
    System.Single
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    GetForwardVector()

    Declaration
    Vector3 GetForwardVector()
    Returns
    Type Description
    System.Numerics.Vector3
    | Improve this Doc View Source

    GetHeadBlendPaletteColor(Byte)

    Get Head Blend Palette Color

    Declaration
    Rgba GetHeadBlendPaletteColor(byte id)
    Parameters
    Type Name Description
    System.Byte id
    Returns
    Type Description
    Rgba
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    GetHeadOverlay(Byte)

    Get Head Overlay

    Declaration
    HeadOverlay GetHeadOverlay(byte overlayID)
    Parameters
    Type Name Description
    System.Byte overlayID
    Returns
    Type Description
    HeadOverlay
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    GetLocalMetaData(String, out MValueConst)

    Declaration
    void GetLocalMetaData(string key, out MValueConst value)
    Parameters
    Type Name Description
    System.String key
    MValueConst value
    | Improve this Doc View Source

    GetLocalMetaData<T>(String, out T)

    Declaration
    bool GetLocalMetaData<T>(string key, out T result)
    Parameters
    Type Name Description
    System.String key
    T result
    Returns
    Type Description
    System.Boolean
    Type Parameters
    Name Description
    T
    | Improve this Doc View Source

    GetProps(Byte)

    Gets the player props

    Declaration
    Prop GetProps(byte component)
    Parameters
    Type Name Description
    System.Byte component
    Returns
    Type Description
    Prop
    | Improve this Doc View Source

    GetProps(Byte, ref Prop)

    Gets the player props

    Declaration
    void GetProps(byte component, ref Prop prop)
    Parameters
    Type Name Description
    System.Byte component
    Prop prop
    | Improve this Doc View Source

    GetWeaponAmmo(UInt32)

    Declaration
    ushort GetWeaponAmmo(uint weaponHash)
    Parameters
    Type Name Description
    System.UInt32 weaponHash
    Returns
    Type Description
    System.UInt16
    | Improve this Doc View Source

    GetWeapons()

    Returns player weapons

    Declaration
    WeaponData[] GetWeapons()
    Returns
    Type Description
    WeaponData[]
    | Improve this Doc View Source

    GetWeaponTintIndex(WeaponModel)

    Declaration
    byte GetWeaponTintIndex(WeaponModel weapon)
    Parameters
    Type Name Description
    WeaponModel weapon
    Returns
    Type Description
    System.Byte
    | Improve this Doc View Source

    GetWeaponTintIndex(UInt32)

    Gets the weapon tint of a weapon

    Declaration
    byte GetWeaponTintIndex(uint weapon)
    Parameters
    Type Name Description
    System.UInt32 weapon

    Weapon hash
    Returns
    Type Description
    System.Byte
    | Improve this Doc View Source

    GiveWeapon(WeaponModel, Int32, Boolean)

    Declaration
    void GiveWeapon(WeaponModel weaponModel, int ammo, bool selectWeapon)
    Parameters
    Type Name Description
    WeaponModel weaponModel
    System.Int32 ammo
    System.Boolean selectWeapon
    | Improve this Doc View Source

    GiveWeapon(UInt32, Int32, Boolean)

    Gives the player a weapon, ammo and if it is active

    Declaration
    void GiveWeapon(uint weapon, int ammo, bool selectWeapon)
    Parameters
    Type Name Description
    System.UInt32 weapon

    weapon hash
    System.Int32 ammo

    ammo count
    System.Boolean selectWeapon

    True - Places into hand
    | Improve this Doc View Source

    HasLocalMetaData(String)

    Declaration
    bool HasLocalMetaData(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    HasWeapon(WeaponModel)

    Declaration
    bool HasWeapon(WeaponModel weapon)
    Parameters
    Type Name Description
    WeaponModel weapon
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    HasWeapon(UInt32)

    Declaration
    bool HasWeapon(uint weapon)
    Parameters
    Type Name Description
    System.UInt32 weapon
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    HasWeaponComponent(WeaponModel, UInt32)

    Declaration
    bool HasWeaponComponent(WeaponModel weapon, uint weaponComponent)
    Parameters
    Type Name Description
    WeaponModel weapon
    System.UInt32 weaponComponent
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    HasWeaponComponent(UInt32, UInt32)

    Checks if a weapon has a component

    Declaration
    bool HasWeaponComponent(uint weapon, uint weaponComponent)
    Parameters
    Type Name Description
    System.UInt32 weapon

    Weapon hash
    System.UInt32 weaponComponent

    Weapon Component hash
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    IsEntityInStreamingRange(IEntity)

    Returns if the entity is in the streaming range of the player

    Declaration
    bool IsEntityInStreamingRange(IEntity entity)
    Parameters
    Type Name Description
    IEntity entity
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Kick(String)

    Kicks the player with reason

    Declaration
    void Kick(string reason)
    Parameters
    Type Name Description
    System.String reason

    Reason why the player is kicked
    | Improve this Doc View Source

    PlayAmbientSpeech(String, String, UInt32)

    Plays ambient speech

    Declaration
    void PlayAmbientSpeech(string speechName, string speechParam, uint speechHash)
    Parameters
    Type Name Description
    System.String speechName
    System.String speechParam
    System.UInt32 speechHash
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    PlayAnimation(String, String, Single, Single, Int32, Int32, Single, Boolean, Boolean, Boolean)

    Declaration
    void PlayAnimation(string animDict, string animName, float blendInSpeed, float blendOutSpeed, int duration, int flags, float playbackRate, bool lockX, bool lockY, bool lockZ)
    Parameters
    Type Name Description
    System.String animDict
    System.String animName
    System.Single blendInSpeed
    System.Single blendOutSpeed
    System.Int32 duration
    System.Int32 flags
    System.Single playbackRate
    System.Boolean lockX
    System.Boolean lockY
    System.Boolean lockZ
    | Improve this Doc View Source

    PlayScenario(String)

    Declaration
    void PlayScenario(string name)
    Parameters
    Type Name Description
    System.String name
    | Improve this Doc View Source

    RemoveAllWeapons(Boolean)

    Removes all player weapons

    Declaration
    void RemoveAllWeapons(bool removeAllAmmo)
    Parameters
    Type Name Description
    System.Boolean removeAllAmmo
    | Improve this Doc View Source

    RemoveDecoration(UInt32, UInt32)

    Declaration
    void RemoveDecoration(uint collection, uint overlay)
    Parameters
    Type Name Description
    System.UInt32 collection
    System.UInt32 overlay
    | Improve this Doc View Source

    RemoveFaceFeature(Byte)

    Remove Face Feature

    Declaration
    bool RemoveFaceFeature(byte index)
    Parameters
    Type Name Description
    System.Byte index
    Returns
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    RemoveHeadBlendData()

    Declaration
    void RemoveHeadBlendData()
    | Improve this Doc View Source

    RemoveHeadBlendPaletteColor()

    Declaration
    void RemoveHeadBlendPaletteColor()
    | Improve this Doc View Source

    RemoveHeadOverlay(Byte)

    Remove Head Overlay

    Declaration
    bool RemoveHeadOverlay(byte overlayId)
    Parameters
    Type Name Description
    System.Byte overlayId
    Returns
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    RemoveWeapon(WeaponModel)

    Declaration
    bool RemoveWeapon(WeaponModel weaponModel)
    Parameters
    Type Name Description
    WeaponModel weaponModel
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    RemoveWeapon(UInt32)

    Removes the weapon by hash

    Declaration
    bool RemoveWeapon(uint weapon)
    Parameters
    Type Name Description
    System.UInt32 weapon
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    RemoveWeaponComponent(WeaponModel, UInt32)

    Declaration
    void RemoveWeaponComponent(WeaponModel weaponModel, uint weaponComponent)
    Parameters
    Type Name Description
    WeaponModel weaponModel
    System.UInt32 weaponComponent
    | Improve this Doc View Source

    RemoveWeaponComponent(UInt32, UInt32)

    Removes a weapon component from a weapon

    Declaration
    void RemoveWeaponComponent(uint weapon, uint weaponComponent)
    Parameters
    Type Name Description
    System.UInt32 weapon

    Weapon hash
    System.UInt32 weaponComponent

    Weapon Component hash
    | Improve this Doc View Source

    SetAmmo(UInt32, UInt16)

    Declaration
    void SetAmmo(uint ammoHash, ushort ammo)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    System.UInt16 ammo
    | Improve this Doc View Source

    SetAmmoFlags(UInt32, AmmoFlags)

    Declaration
    void SetAmmoFlags(uint ammoHash, AmmoFlags ammoFlags)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    AmmoFlags ammoFlags
    | Improve this Doc View Source

    SetAmmoMax(UInt32, Int32)

    Declaration
    void SetAmmoMax(uint ammoHash, int ammoMax)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    System.Int32 ammoMax
    | Improve this Doc View Source

    SetAmmoMax100(UInt32, Int32)

    Declaration
    void SetAmmoMax100(uint ammoHash, int ammoMax)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    System.Int32 ammoMax
    | Improve this Doc View Source

    SetAmmoMax50(UInt32, Int32)

    Declaration
    void SetAmmoMax50(uint ammoHash, int ammoMax)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    System.Int32 ammoMax
    | Improve this Doc View Source

    SetAmmoSpecialType(UInt32, AmmoSpecialType)

    Declaration
    void SetAmmoSpecialType(uint ammoHash, AmmoSpecialType ammoSpecialType)
    Parameters
    Type Name Description
    System.UInt32 ammoHash
    AmmoSpecialType ammoSpecialType
    | Improve this Doc View Source

    SetClothes(Byte, UInt16, Byte, Byte)

    Sets the player clothes

    Declaration
    bool SetClothes(byte component, ushort drawable, byte texture, byte palette)
    Parameters
    Type Name Description
    System.Byte component
    System.UInt16 drawable
    System.Byte texture
    System.Byte palette
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    SetDateTime(DateTime)

    Declaration
    void SetDateTime(DateTime dateTime)
    Parameters
    Type Name Description
    System.DateTime dateTime
    | Improve this Doc View Source

    SetDateTime(Int32, Int32, Int32, Int32, Int32, Int32)

    Sets the current date and time for a player

    Declaration
    void SetDateTime(int day, int month, int year, int hour, int minute, int second)
    Parameters
    Type Name Description
    System.Int32 day
    System.Int32 month
    System.Int32 year
    System.Int32 hour
    System.Int32 minute
    System.Int32 second
    | Improve this Doc View Source

    SetDlcClothes(Byte, UInt16, Byte, Byte, UInt32)

    Sets the player dlc clothes

    Declaration
    bool SetDlcClothes(byte component, ushort drawable, byte texture, byte palette, uint dlc)
    Parameters
    Type Name Description
    System.Byte component

    Id of the component
    System.UInt16 drawable

    Drawable id of the component. Can't be higher then 127
    System.Byte texture

    Texture id of the component
    System.Byte palette

    Palette id of the component
    System.UInt32 dlc

    Hash of the components dlc pack
    Returns
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    Thrown if drawable id is higher then 127
    | Improve this Doc View Source

    SetDlcProps(Byte, UInt16, Byte, UInt32)

    Sets the player dlc props

    Declaration
    bool SetDlcProps(byte component, ushort drawable, byte texture, uint dlc)
    Parameters
    Type Name Description
    System.Byte component
    System.UInt16 drawable
    System.Byte texture
    System.UInt32 dlc
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    SetEyeColor(UInt16)

    Set Eye Color

    Declaration
    bool SetEyeColor(ushort eyeColor)
    Parameters
    Type Name Description
    System.UInt16 eyeColor
    Returns
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    SetFaceFeature(Byte, Single)

    Set Face Feature

    Declaration
    bool SetFaceFeature(byte index, float scale)
    Parameters
    Type Name Description
    System.Byte index
    System.Single scale
    Returns
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    SetHeadBlendData(UInt32, UInt32, UInt32, UInt32, UInt32, UInt32, Single, Single, Single)

    Set Head Blend Data

    Declaration
    void SetHeadBlendData(uint shapeFirstID, uint shapeSecondID, uint shapeThirdID, uint skinFirstID, uint skinSecondID, uint skinThirdID, float shapeMix, float skinMix, float thirdMix)
    Parameters
    Type Name Description
    System.UInt32 shapeFirstID
    System.UInt32 shapeSecondID
    System.UInt32 shapeThirdID
    System.UInt32 skinFirstID
    System.UInt32 skinSecondID
    System.UInt32 skinThirdID
    System.Single shapeMix
    System.Single skinMix
    System.Single thirdMix
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    SetHeadBlendPaletteColor(Byte, Rgba)

    Set Head Blend Palette Color

    Declaration
    bool SetHeadBlendPaletteColor(byte id, Rgba rgba)
    Parameters
    Type Name Description
    System.Byte id
    Rgba rgba
    Returns
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    SetHeadOverlay(Byte, Byte, Single)

    Set Head Overlay

    Declaration
    bool SetHeadOverlay(byte overlayId, byte index, float opacity)
    Parameters
    Type Name Description
    System.Byte overlayId
    System.Byte index
    System.Single opacity
    Returns
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    SetHeadOverlayColor(Byte, Byte, Byte, Byte)

    Set Head Overlay Color

    Declaration
    bool SetHeadOverlayColor(byte overlayId, byte colorType, byte colorIndex, byte secondColorIndex)
    Parameters
    Type Name Description
    System.Byte overlayId
    System.Byte colorType
    System.Byte colorIndex
    System.Byte secondColorIndex
    Returns
    Type Description
    System.Boolean
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    SetIntoVehicle(IVehicle, Byte)

    Declaration
    void SetIntoVehicle(IVehicle vehicle, byte seat)
    Parameters
    Type Name Description
    IVehicle vehicle
    System.Byte seat
    | Improve this Doc View Source

    SetLocalMetaData(String, in MValueConst)

    Declaration
    void SetLocalMetaData(string key, in MValueConst value)
    Parameters
    Type Name Description
    System.String key
    MValueConst value
    | Improve this Doc View Source

    SetLocalMetaData(String, Object)

    Declaration
    void SetLocalMetaData(string key, object value)
    Parameters
    Type Name Description
    System.String key
    System.Object value
    | Improve this Doc View Source

    SetProps(Byte, UInt16, Byte)

    Sets the player props

    Declaration
    bool SetProps(byte component, ushort drawable, byte texture)
    Parameters
    Type Name Description
    System.Byte component
    System.UInt16 drawable
    System.Byte texture
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    SetWeaponAmmo(UInt32, UInt16)

    Declaration
    void SetWeaponAmmo(uint weaponHash, ushort ammo)
    Parameters
    Type Name Description
    System.UInt32 weaponHash
    System.UInt16 ammo
    | Improve this Doc View Source

    SetWeaponTintIndex(WeaponModel, Byte)

    Declaration
    void SetWeaponTintIndex(WeaponModel weaponModel, byte tintIndex)
    Parameters
    Type Name Description
    WeaponModel weaponModel
    System.Byte tintIndex
    | Improve this Doc View Source

    SetWeaponTintIndex(UInt32, Byte)

    Sets the weapon tint to a weapon

    Declaration
    void SetWeaponTintIndex(uint weapon, byte tintIndex)
    Parameters
    Type Name Description
    System.UInt32 weapon

    Weapon hash
    System.Byte tintIndex

    tintIndex
    | Improve this Doc View Source

    SetWeather(WeatherType)

    Declaration
    void SetWeather(WeatherType weatherType)
    Parameters
    Type Name Description
    WeatherType weatherType
    | Improve this Doc View Source

    SetWeather(UInt32)

    Sets the current weather for the player

    Declaration
    void SetWeather(uint weather)
    Parameters
    Type Name Description
    System.UInt32 weather
    | Improve this Doc View Source

    Spawn(PedModel, Position, UInt32)

    Spawns a player with given model at the designated position with a optional delay in milliseconds

    Declaration
    void Spawn(PedModel model, Position position, uint delayMs = 0U)
    Parameters
    Type Name Description
    PedModel model

    the players model / skin
    Position position

    position
    System.UInt32 delayMs

    delay in milliseconds until player is spawned
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    Spawn(Position, UInt32)

    Spawns a player at the designated position with a optional delay in milliseconds

    Declaration
    void Spawn(Position position, uint delayMs = 0U)
    Parameters
    Type Name Description
    Position position

    position
    System.UInt32 delayMs

    delay in milliseconds until player is spawned
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    Spawn(UInt32, Position, UInt32)

    Spawns a player with given model at the designated position with a optional delay in milliseconds

    Declaration
    void Spawn(uint model, Position position, uint delayMs = 0U)
    Parameters
    Type Name Description
    System.UInt32 model

    the players model / skin
    Position position

    position
    System.UInt32 delayMs

    delay in milliseconds until player is spawned
    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed

    Extension Methods