Index

Search Results for

    Interface ISharedBaseObject

    Inherited Members
    Namespace: AltV.Net.Shared.Elements.Entities
    Assembly: AltV.Net.Shared.dll
    Syntax
    public interface ISharedBaseObject : INative

    Properties

    | Improve this Doc View Source

    BaseObjectNativePointer

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

    Cached

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

    Core

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

    Id

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

    Type

    Declaration
    BaseObjectType Type { get; }
    Property Value
    Type Description
    BaseObjectType

    Methods

    | Improve this Doc View Source

    CheckIfEntityExists()

    Declaration
    void CheckIfEntityExists()
    | Improve this Doc View Source

    CheckIfEntityExistsOrCached()

    Declaration
    void CheckIfEntityExistsOrCached()
    | Improve this Doc View Source

    ClearData()

    Deletes all set data from the entity.

    Declaration
    void ClearData()
    Remarks

    Data is accessible only within the resource that set the data.

    | Improve this Doc View Source

    DeleteData(String)

    Deletes a value by a given key from the entity.

    Declaration
    void DeleteData(string key)
    Parameters
    Type Name Description
    System.String key
    Remarks

    Data is accessible only within the resource that set the data.

    | Improve this Doc View Source

    DeleteMetaData(String)

    Deletes a meta data key from an entity.

    Declaration
    void DeleteMetaData(string key)
    Parameters
    Type Name Description
    System.String key
    Remarks

    Meta data is accessible across different serverside resources.

    | Improve this Doc View Source

    Destroy()

    Destroy the baseobject

    Declaration
    void Destroy()
    | Improve this Doc View Source

    GetAllDataKeys()

    Returns all stored data keys retrievable with GetData<T>(String, out T)

    Declaration
    IEnumerable<string> GetAllDataKeys()
    Returns
    Type Description
    IEnumerable<System.String>

    IEnumerable
    | Improve this Doc View Source

    GetData<T>(String, out T)

    Returns data for a given key.

    Declaration
    bool GetData<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
    Remarks

    Data is accessible only within the resource that set the data.

    | Improve this Doc View Source

    GetMetaData(String, out MValueConst)

    Returns meta data for a given key.

    Declaration
    void GetMetaData(string key, out MValueConst result)
    Parameters
    Type Name Description
    System.String key
    MValueConst result
    Remarks

    Meta data is accessible across different serverside resources.

    | Improve this Doc View Source

    GetMetaData<T>(String, out T)

    Returns meta data for a given key.

    Declaration
    bool GetMetaData<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
    Remarks

    Meta data is accessible across different serverside resources.

    | Improve this Doc View Source

    GetSyncedMetaData(String, out MValueConst)

    Gets the synced meta data of an entity.

    Declaration
    void GetSyncedMetaData(string key, out MValueConst value)
    Parameters
    Type Name Description
    System.String key
    MValueConst value
    Remarks

    Synced meta data is accessible across different serverside resources and across all clients.

    | Improve this Doc View Source

    GetSyncedMetaData<T>(String, out T)

    Get synced meta data of the entity.

    Declaration
    bool GetSyncedMetaData<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
    Remarks

    Synced meta data is accessible across different serverside resources and across all clients.

    Exceptions
    Type Condition
    EntityRemovedException

    This entity was removed
    | Improve this Doc View Source

    HasData(String)

    Checks if the entity has a value for the given key.

    Declaration
    bool HasData(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Boolean
    Remarks

    Data is accessible only within the resource that set the data.

    | Improve this Doc View Source

    HasMetaData(String)

    Checks if the entity has a given meta data key.

    Declaration
    bool HasMetaData(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Boolean
    Remarks

    Meta data is accessible across different serverside resources.

    | Improve this Doc View Source

    HasSyncedMetaData(String)

    Checks if a synced meta data key is set on an entity.

    Declaration
    bool HasSyncedMetaData(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Boolean
    Remarks

    Synced meta data is accessible across different serverside resources and across all clients.

    | Improve this Doc View Source

    OnDestroy()

    Declaration
    void OnDestroy()
    | Improve this Doc View Source

    SetData(String, Object)

    Sets a value with a given on an entity.

    Declaration
    void SetData(string key, object value)
    Parameters
    Type Name Description
    System.String key
    System.Object value
    Remarks

    Data is accessible only within the resource that set the data.

    | Improve this Doc View Source

    SetMetaData(Dictionary<String, Object>)

    Declaration
    void SetMetaData(Dictionary<string, object> metaData)
    Parameters
    Type Name Description
    Dictionary<System.String, System.Object> metaData
    | Improve this Doc View Source

    SetMetaData(String, in MValueConst)

    Sets the given object into the meta data with the given key.

    Declaration
    void SetMetaData(string key, in MValueConst value)
    Parameters
    Type Name Description
    System.String key
    MValueConst value
    Remarks

    Meta data is accessible across different serverside resources.

    Exceptions
    Type Condition
    EntityRemovedException

    This entity was deleted before
    | Improve this Doc View Source

    SetMetaData(String, Object)

    Sets the given object into the meta data with the given key.

    Declaration
    void SetMetaData(string key, object value)
    Parameters
    Type Name Description
    System.String key
    System.Object value
    Remarks

    Meta data is accessible across different serverside resources.

    Exceptions
    Type Condition
    EntityRemovedException

    This entity was deleted before