ogd.games.AQUALAB.features package

Submodules

ogd.games.AQUALAB.features.ActiveJobs module

class ogd.games.AQUALAB.features.ActiveJobs.ActiveJobs(params: GeneratorParameters, job_map: dict)

Bases: Extractor

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.ActiveTime module

class ogd.games.AQUALAB.features.ActiveTime.ActiveTime(params: GeneratorParameters, job_map: dict, active_threads: float | None = None)

Bases: Extractor

IDLE_LEVEL: Final[int] = 30

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.AppVersions module

class ogd.games.AQUALAB.features.AppVersions.AppVersions(params: GeneratorParameters)

Bases: SessionFeature

_summary_

Parameters:

SessionFeature (_type_) – _description_

ogd.games.AQUALAB.features.AverageSessionTime module

class ogd.games.AQUALAB.features.AverageSessionTime.AverageSessionTime(params: GeneratorParameters)

Bases: Extractor

static AvailableModes() → List[ExtractionMode]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.EchoSessionID module

class ogd.games.AQUALAB.features.EchoSessionID.EchoSessionID(params: GeneratorParameters)

Bases: SessionFeature

ogd.games.AQUALAB.features.EventList module

class ogd.games.AQUALAB.features.EventList.EventList(params: GeneratorParameters)

Bases: Extractor

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.JobActiveTime module

class ogd.games.AQUALAB.features.JobActiveTime.JobActiveTime(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static AvailableModes() → List[ExtractionMode]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.JobArgumentation module

class ogd.games.AQUALAB.features.JobArgumentation.JobArgumentation(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.JobCompletionTime module

class ogd.games.AQUALAB.features.JobCompletionTime.JobCompletionTime(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.JobDiveSitesCount module

class ogd.games.AQUALAB.features.JobDiveSitesCount.JobDiveSitesCount(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.JobDiveTime module

class ogd.games.AQUALAB.features.JobDiveTime.JobDiveTime(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.JobExperimentation module

class ogd.games.AQUALAB.features.JobExperimentation.JobExperimentation(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.JobGuideCount module

class ogd.games.AQUALAB.features.JobGuideCount.JobGuideCount(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.JobHelpCount module

class ogd.games.AQUALAB.features.JobHelpCount.JobHelpCount(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.JobLocationChanges module

class ogd.games.AQUALAB.features.JobLocationChanges.JobLocationChanges(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.JobModeling module

class ogd.games.AQUALAB.features.JobModeling.JobModeling(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.JobPlayTime module

class ogd.games.AQUALAB.features.JobPlayTime.JobPlayTime(params: GeneratorParameters, job_map: dict, active_threads: float | None = None)

Bases: Extractor

IDLE_LEVEL: Final[int] = 30

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.JobPriorAttempt module

class ogd.games.AQUALAB.features.JobPriorAttempt.JobPriorAttempt(params: GeneratorParameters, job_map: dict)

Bases: PerCountFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.JobPriorComplete module

class ogd.games.AQUALAB.features.JobPriorComplete.JobPriorComplete(params: GeneratorParameters, job_map: dict)

Bases: PerCountFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.JobStartCount module

class ogd.games.AQUALAB.features.JobStartCount.JobStartCount(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

ogd.games.AQUALAB.features.JobTasksCompleted module

class ogd.games.AQUALAB.features.JobTasksCompleted.JobTasksCompleted(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.JobTriesInArgument module

class ogd.games.AQUALAB.features.JobTriesInArgument.JobTriesInArgument(params: GeneratorParameters, job_map: dict)

Bases: PerJobFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.JobsAttempted module

class ogd.games.AQUALAB.features.JobsAttempted.JobsAttempted(params: GeneratorParameters, job_map: dict, diff_map: dict)

Bases: Extractor

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.JobsCompleted module

class ogd.games.AQUALAB.features.JobsCompleted.JobsCompleted(params: GeneratorParameters, player_id: str)

Bases: SessionFeature

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.ModelExportCount module

class ogd.games.AQUALAB.features.ModelExportCount.ModelExportCount(params: GeneratorParameters, job_map: dict)

Bases: Extractor

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.ModelInterveneCount module

class ogd.games.AQUALAB.features.ModelInterveneCount.ModelInterveneCount(params: GeneratorParameters, job_map: dict)

Bases: Extractor

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.ModelPredictCount module

class ogd.games.AQUALAB.features.ModelPredictCount.ModelPredictCount(params: GeneratorParameters, job_map: dict)

Bases: Extractor

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.PerJobFeature module

class ogd.games.AQUALAB.features.PerJobFeature.PerJobFeature(params: GeneratorParameters, job_map: dict)

Bases: PerCountFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

property TargetJobName: str

ogd.games.AQUALAB.features.PlayerSummary module

class ogd.games.AQUALAB.features.PlayerSummary.PlayerSummary(params: GeneratorParameters)

Bases: SessionFeature

static AvailableModes() → List[ExtractionMode]

List of ExtractionMode supported by the Feature.

Overridden from base Feature version. A PlayerSummary is only used at player and population levels; not concerned with session-level. :return: _description_ :rtype: List[ExtractionMode]

ogd.games.AQUALAB.features.PopulationSummary module

class ogd.games.AQUALAB.features.PopulationSummary.PopulationSummary(params: GeneratorParameters)

Bases: SessionFeature

static AvailableModes() → List[ExtractionMode]

List of ExtractionMode supported by the Feature.

Overridden from base Feature version. A PlayerSummary is only used at player and population levels; not concerned with session-level. :return: _description_ :rtype: List[ExtractionMode]

ogd.games.AQUALAB.features.RegionJobCount module

class ogd.games.AQUALAB.features.RegionJobCount.RegionJobCount(params: GeneratorParameters)

Bases: PerCountFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.RegionName module

class ogd.games.AQUALAB.features.RegionName.RegionName(params: GeneratorParameters)

Bases: PerCountFeature

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.SessionDiveSitesCount module

class ogd.games.AQUALAB.features.SessionDiveSitesCount.SessionDiveSitesCount(params: GeneratorParameters)

Bases: Extractor

ogd.games.AQUALAB.features.SessionDuration module

class ogd.games.AQUALAB.features.SessionDuration.SessionDuration(params: GeneratorParameters, threshold: int)

Bases: SessionFeature

static AvailableModes() → List[ExtractionMode]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.SessionGuideCount module

class ogd.games.AQUALAB.features.SessionGuideCount.SessionGuideCount(params: GeneratorParameters)

Bases: Extractor

ogd.games.AQUALAB.features.SessionHelpCount module

class ogd.games.AQUALAB.features.SessionHelpCount.SessionHelpCount(params: GeneratorParameters)

Bases: Extractor

_summary_

Parameters:

Feature (_type_) – _description_

ogd.games.AQUALAB.features.SessionID module

class ogd.games.AQUALAB.features.SessionID.SessionID(params: GeneratorParameters, session_id: str)

Bases: SessionFeature

_summary_

Parameters:

SessionFeature (_type_) – _description_

ogd.games.AQUALAB.features.SessionJobsCompleted module

class ogd.games.AQUALAB.features.SessionJobsCompleted.SessionJobsCompleted(params: GeneratorParameters)

Bases: Extractor

_summary_

Parameters:

Feature (_type_) – _description_

ogd.games.AQUALAB.features.SwitchJobsCount module

class ogd.games.AQUALAB.features.SwitchJobsCount.SwitchJobsCount(params: GeneratorParameters)

Bases: Extractor

ogd.games.AQUALAB.features.SyncCompletionTime module

class ogd.games.AQUALAB.features.SyncCompletionTime.SyncCompletionTime(params: GeneratorParameters)

Bases: Extractor

ogd.games.AQUALAB.features.TankRulesCount module

class ogd.games.AQUALAB.features.TankRulesCount.TankRulesCount(params: GeneratorParameters)

Bases: PerCountFeature

ogd.games.AQUALAB.features.TopJobCompletionDestinations module

class ogd.games.AQUALAB.features.TopJobCompletionDestinations.TopJobCompletionDestinations(params: GeneratorParameters, job_map: dict)

Bases: Extractor

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.TopJobSwitchDestinations module

class ogd.games.AQUALAB.features.TopJobSwitchDestinations.TopJobSwitchDestinations(params: GeneratorParameters, job_map: dict)

Bases: Extractor

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

ogd.games.AQUALAB.features.TotalArcticTime module

class ogd.games.AQUALAB.features.TotalArcticTime.TotalArcticTime(params: GeneratorParameters)

Bases: Extractor

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.TotalArgumentationTime module

class ogd.games.AQUALAB.features.TotalArgumentationTime.TotalArgumentationTime(params: GeneratorParameters)

Bases: Extractor

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.TotalBayouTime module

class ogd.games.AQUALAB.features.TotalBayouTime.TotalBayouTime(params: GeneratorParameters)

Bases: Extractor

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.TotalCoralTime module

class ogd.games.AQUALAB.features.TotalCoralTime.TotalCoralTime(params: GeneratorParameters)

Bases: Extractor

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.TotalDiveTime module

class ogd.games.AQUALAB.features.TotalDiveTime.TotalDiveTime(params: GeneratorParameters)

Bases: Extractor

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.TotalExperimentationTime module

class ogd.games.AQUALAB.features.TotalExperimentationTime.TotalExperimentationTime(params: GeneratorParameters)

Bases: Extractor

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.TotalGuideCount module

class ogd.games.AQUALAB.features.TotalGuideCount.TotalGuideCount(params: GeneratorParameters)

Bases: Extractor

ogd.games.AQUALAB.features.TotalHelpCount module

class ogd.games.AQUALAB.features.TotalHelpCount.TotalHelpCount(params: GeneratorParameters)

Bases: Extractor

_summary_

Parameters:

Feature (_type_) – _description_

ogd.games.AQUALAB.features.TotalKelpTime module

class ogd.games.AQUALAB.features.TotalKelpTime.TotalKelpTime(params: GeneratorParameters)

Bases: Extractor

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.TotalModelingTime module

class ogd.games.AQUALAB.features.TotalModelingTime.TotalModelingTime(params: GeneratorParameters)

Bases: Extractor

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.TotalPlayTime module

class ogd.games.AQUALAB.features.TotalPlayTime.TotalPlayTime(params: GeneratorParameters)

Bases: Extractor

static AvailableModes() → List[ExtractionMode]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

static MinVersion() → str | None

Base function to get the minimum log version the feature can handle.

A value of None will set no minimum, so all levels are accepted (unless a max is set). Typically default to None, unless there is a required element of the event data that was not added until a certain version. The versions of data accepted by a feature are a responsibility of the Feature’s developer, so this is a required part of interface instead of a config item in the schema.

Returns:

[description]

Return type:

Optional[str]

Subfeatures() → List[str]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:

A list of names of subfeatures for the Feature sub-class.

Return type:

Tuple[str]

ogd.games.AQUALAB.features.UserAvgActiveTime module

class ogd.games.AQUALAB.features.UserAvgActiveTime.UserAvgActiveTime(params: GeneratorParameters, player_id: str)

Bases: SessionFeature

ogd.games.AQUALAB.features.UserAvgSessionDuration module

class ogd.games.AQUALAB.features.UserAvgSessionDuration.UserAvgSessionDuration(params: GeneratorParameters, player_id: str)

Bases: SessionFeature

ogd.games.AQUALAB.features.UserTotalSessionDuration module

class ogd.games.AQUALAB.features.UserTotalSessionDuration.UserTotalSessionDuration(params: GeneratorParameters, player_id: str)

Bases: SessionFeature

_summary_

Parameters:

SessionFeature (_type_) – _description_

Module contents

Initializer for Aqualab features