Class ArchetypeService#
Defined in File ArchetypeService.cs
Inheritance Relationships#
Base Type#
public xbe.sdk.ServiceBase(Class ServiceBase)
Class Documentation#
- class xbe.sdk.Services.ArchetypeService : xbe.sdk.ServiceBase#
Public Functions
- ArchetypeService ()#
- Task<List<ArchetypeDefinition>> FindAll (Guid personaUid, Dictionary<string, string> query = null)#
Retrieves a list of all archetypes that the given persona has activated.
- Param personaUid:
The unique identifier of the persona whose archetypes will be returned.
- Param query:
Parameters defining the server query
- Return:
A task whose result is a list of objects matching the specified search parameters.
- Task<long?> Count (Guid personaUid, Dictionary<string, string> query = null)#
Returns the count of archetypes that a persona has activated.
- Param personaUid:
The unique identifier of the persona whose archetypes will be counted.
- Param query:
Parameters defining the server query
- Return:
A task whose result is the number of objects matching the specified search parameters.
- Task DeactivateAll (Guid personaUid)#
Stops tracking all progress for all archetypes and persona.
- Param personaUid:
personaUid The unique identifier of the persona whose archetypes will be deactivated.
- Return:
A task.
- Task<ArchetypeDefinition> FindById (Guid personaUid, Guid archetypeUid)#
Retrieves an instance of ArchetypeDefinition with the specified unique identifier.
- Param personaUid:
The unique identifier of the persona.
- Param archetypeUid:
The unique identifier of the archetype.
- Return:
A task whose result is the object with the specified identifier if found.
- Task Deactivate (Guid personaUid, Guid archetypeUid)#
Stops tracking all progress for the given archetype and persona.
- Param personaUid:
The unique identifier of the persona.
- Param archetypeUid:
The unique identifier of the archetype.
- Return:
A task.
- Task Toggle (Guid personaUid, Guid archetypeUid, ArchetypeActivation obj)#
Toggles the activation state of all skill progress for a given archetype and persona.
- Param personaUid:
The unique identifier of the persona.
- Param archetypeUid:
The unique identifier of the archetype.
- Param obj:
The activation state to toggle the archetype to.
- Return:
A task