ogd.games.ICECUBE.features package

Submodules

ogd.games.ICECUBE.features.HeadsetOnCount module

class ogd.games.ICECUBE.features.HeadsetOnCount.HeadsetOnCount(params: GeneratorParameters)

Bases: SessionFeature

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.ICECUBE.features.ObjectSelectionsDuringVoiceover module

class ogd.games.ICECUBE.features.ObjectSelectionsDuringVoiceover.ObjectSelectionsDuringVoiceover(params: GeneratorParameters)

Bases: SessionFeature

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.ICECUBE.features.PerSceneFeature module

class ogd.games.ICECUBE.features.PerSceneFeature.PerSceneFeature(params: GeneratorParameters)

Bases: PerCountFeature

PerLevelFeature Abstract base class for per-level game features. Works like a normal Feature, but checks if the given event has right “level” before attempting to extract from event.

Args:

Feature (_type_): PerLevelFeature is a subclass of Feature

Returns:

_type_: _description_

ogd.games.ICECUBE.features.SceneDuration module

class ogd.games.ICECUBE.features.SceneDuration.SceneDuration(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.ICECUBE.features.SceneFailureCount module

class ogd.games.ICECUBE.features.SceneFailureCount.SceneFailureCount(params: GeneratorParameters)

Bases: SessionFeature

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.ICECUBE.features.SceneFailures module

class ogd.games.ICECUBE.features.SceneFailures.SceneFailures(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.ICECUBE.features.ScenesEncountered module

class ogd.games.ICECUBE.features.ScenesEncountered.ScenesEncountered(params: GeneratorParameters)

Bases: SessionFeature

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.ICECUBE.features.SessionDuration module

class ogd.games.ICECUBE.features.SessionDuration.SessionDuration(params: GeneratorParameters, session_id: str)

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:

Feature (_type_) – Base class for a Custom Feature class.

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.ICECUBE.features.Session_Language module

class ogd.games.ICECUBE.features.Session_Language.Session_Language(params: GeneratorParameters)

Bases: SessionFeature

_summary_

Parameters:

SessionFeature (_type_) – _description_

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.ICECUBE.features.TaskTimeToComplete module

class ogd.games.ICECUBE.features.TaskTimeToComplete.TaskTimeToComplete(params: GeneratorParameters)

Bases: SessionFeature

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.ICECUBE.features.ViewportCountPerScene module

class ogd.games.ICECUBE.features.ViewportCountPerScene.ViewportCountPerScene(params: GeneratorParameters)

Bases: SessionFeature

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]

Module contents

Initializer for Icecube features