ogd.games.JOWILDER.features package

Submodules

ogd.games.JOWILDER.features.ActiveStateTime module

class ogd.games.JOWILDER.features.ActiveStateTime.ActiveStateTime(params: GeneratorParameters, threshold: int)

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.

ACTIVE_TIME_THRESHOLD: Final[timedelta] = datetime.timedelta(seconds=15)

CLICK_EVENTS_NAME: Final[List[str]] = ['CUSTOM.3', 'CUSTOM.4', 'CUSTOM.5', 'CUSTOM.6', 'CUSTOM.7', 'CUSTOM.8', 'CUSTOM.9', 'CUSTOM.10', 'CUSTOM.11']

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.JOWILDER.features.Clicks module

class ogd.games.JOWILDER.features.Clicks.Clicks(params: GeneratorParameters)

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.

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.JOWILDER.features.EventCount module

class ogd.games.JOWILDER.features.EventCount.EventCount(params: GeneratorParameters)

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.

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.JOWILDER.features.FirstInteraction module

class ogd.games.JOWILDER.features.FirstInteraction.FirstInteraction(params: GeneratorParameters)

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.

NO_SENSE: Final[str] = 'tunic.historicalsociety.closet.intro'

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.JOWILDER.features.GameScript module

class ogd.games.JOWILDER.features.GameScript.GameScript(params: GeneratorParameters)

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.

BaseFeatureSuffix() → str

Base function to add a suffix to the base feature name, which will not affect the naming of subfeatures. By default, returns “”; override to set a suffix. Example use-case: Suppose you want a feature that captures the number of times a player enters a given state, as well as the time spent in that state. The feature can be named “State”, with BaseFeatureSuffix returning “EntryCount” and a subfeature named “Time.” Then the columns will be named “StateEntryCount” and “StateTime.”

Returns:

_description_

Return type:

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]

TYPE: Final[Dict[int, str]] = {0: 'Dry', 1: 'No Humor', 2: 'No Snark', 3: 'Normal'}

ogd.games.JOWILDER.features.GameVersion module

class ogd.games.JOWILDER.features.GameVersion.GameVersion(params: GeneratorParameters)

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.

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.JOWILDER.features.Hovers module

class ogd.games.JOWILDER.features.Hovers.Hovers(params: GeneratorParameters)

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.

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.JOWILDER.features.IdleState module

class ogd.games.JOWILDER.features.IdleState.IdleState(params: GeneratorParameters, threshold: int)

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.

BaseFeatureSuffix() → str

Base function to add a suffix to the base feature name, which will not affect the naming of subfeatures. By default, returns “”; override to set a suffix. Example use-case: Suppose you want a feature that captures the number of times a player enters a given state, as well as the time spent in that state. The feature can be named “State”, with BaseFeatureSuffix returning “EntryCount” and a subfeature named “Time.” Then the columns will be named “StateEntryCount” and “StateTime.”

Returns:

_description_

Return type:

str

IDLE_TIME_THRESHOLD: Final[timedelta] = datetime.timedelta(seconds=15)

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]

static defaultThreshold()

ogd.games.JOWILDER.features.Interaction module

class ogd.games.JOWILDER.features.Interaction.ClickTrack(start_time: datetime | None = None, game_start: bool = False, this_click: Event | None = None, last_click: Event | None = None)

Bases: object

static EventEq(event1: Event, event2: Event) → bool

property GameStart: bool

property GameStartTime: datetime | None

property LastClickTime: datetime | None

property LastInteractionIndex: int | None

StartNewInteraction(this_interaction: int | None)

Update(event: Event) → timedelta

startGame(event: Event)

class ogd.games.JOWILDER.features.Interaction.Interaction(params: GeneratorParameters)

Bases: PerCountFeature

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

Parameters:

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

BaseFeatureSuffix() → str

Base function to add a suffix to the base feature name, which will not affect the naming of subfeatures. By default, returns “”; override to set a suffix. Example use-case: Suppose you want a feature that captures the number of times a player enters a given state, as well as the time spent in that state. The feature can be named “State”, with BaseFeatureSuffix returning “EntryCount” and a subfeature named “Time.” Then the columns will be named “StateEntryCount” and “StateTime.”

Returns:

_description_

Return type:

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.JOWILDER.features.InteractionName module

class ogd.games.JOWILDER.features.InteractionName.InteractionName(params=<class 'ogd.core.generators.Generator.GeneratorParameters'>)

Bases: PerCountFeature

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.JOWILDER.features.InteractionTextBoxesPerSecond module

class ogd.games.JOWILDER.features.InteractionTextBoxesPerSecond.InteractionTextBoxesPerSecond(params: GeneratorParameters)

Bases: PerCountFeature

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

Parameters:

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

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.JOWILDER.features.InteractionWordsPerSecond module

class ogd.games.JOWILDER.features.InteractionWordsPerSecond.InteractionWordsPerSecond(params: GeneratorParameters)

Bases: PerCountFeature

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

Parameters:

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

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.JOWILDER.features.LastInteraction module

class ogd.games.JOWILDER.features.LastInteraction.LastInteraction(params: GeneratorParameters)

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.

NO_SENSE: Final[str] = 'tunic.historicalsociety.closet.intro'

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.JOWILDER.features.MeaningfulActions module

class ogd.games.JOWILDER.features.MeaningfulActions.MeaningfulActions(params: GeneratorParameters)

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.

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.JOWILDER.features.NotebookUses module

class ogd.games.JOWILDER.features.NotebookUses.NotebookUses(params: GeneratorParameters)

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.

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.JOWILDER.features.QuestionAnswers module

class ogd.games.JOWILDER.features.QuestionAnswers.QuestionAnswers(params: GeneratorParameters)

Bases: PerCountFeature

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

class ogd.games.JOWILDER.features.SessionDuration.SessionDuration(params: GeneratorParameters)

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.

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.JOWILDER.features.SessionStart module

class ogd.games.JOWILDER.features.SessionStart.SessionStart(params: GeneratorParameters)

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.

BaseFeatureSuffix() → str

Base function to add a suffix to the base feature name, which will not affect the naming of subfeatures. By default, returns “”; override to set a suffix. Example use-case: Suppose you want a feature that captures the number of times a player enters a given state, as well as the time spent in that state. The feature can be named “State”, with BaseFeatureSuffix returning “EntryCount” and a subfeature named “Time.” Then the columns will be named “StateEntryCount” and “StateTime.”

Returns:

_description_

Return type:

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.JOWILDER.features.SurveyItem module

class ogd.games.JOWILDER.features.SurveyItem.SurveyItem(params: GeneratorParameters)

Bases: PerCountFeature

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

Parameters:

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

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.JOWILDER.features.SurveyTime module

class ogd.games.JOWILDER.features.SurveyTime.SurveyTime(params=<class 'ogd.core.generators.Generator.GeneratorParameters'>)

Bases: PerCountFeature

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 MaxVersion() → str | None

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

A value of None will set no maximum, so all levels are accepted (unless a min is set). Typically default to None, unless the feature is not compatible with new data and is only kept for legacy purposes. 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]

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.JOWILDER.features.UsedContinue module

class ogd.games.JOWILDER.features.UsedContinue.UsedContinue(params: GeneratorParameters)

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.

START_SIGN: Final[str] = 'tunic.historicalsociety.closet.gramps.intro_0_cs_0'

ogd.games.JOWILDER.features.UsedSaveCode module

class ogd.games.JOWILDER.features.UsedSaveCode.UsedSaveCode(params: GeneratorParameters)

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.

ogd.games.JOWILDER.features.UserEnabled module

class ogd.games.JOWILDER.features.UserEnabled.UserEnabled(params: GeneratorParameters)

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.

BaseFeatureSuffix() → str

Base function to add a suffix to the base feature name, which will not affect the naming of subfeatures. By default, returns “”; override to set a suffix. Example use-case: Suppose you want a feature that captures the number of times a player enters a given state, as well as the time spent in that state. The feature can be named “State”, with BaseFeatureSuffix returning “EntryCount” and a subfeature named “Time.” Then the columns will be named “StateEntryCount” and “StateTime.”

Returns:

_description_

Return type:

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]

Module contents

Initializer for Jo Wilder features