Module nari.io.reader.actlogutils.visibility

Parse visibility data from ACT log line

"""Parse visibility data from ACT log line"""
from nari.types import Timestamp
from nari.types.actor import Actor
from nari.types.event import Event
from nari.types.event.visibility import VisibilityCategory, VisibilityChange, VisibilityState


def visibility_from_logline(timestamp: Timestamp, params: list[str]) -> Event:
    """Parses a VisibilityChange event from an ACT log line

    ACT Event ID (decimal): 34

    ## Param layout from ACT

    The first two params in every event is the ACT event ID and the timestamp it was parsed; the following table documents all the other fields.

    |Index|Type|Description|
    |----:|----|:----------|
    |0    |int|Source actor ID|
    |1    |string|Source actor name|
    |2    |int|Target actor ID|
    |3    |string|Target actor name|
    |4    |int|0 for invisible, 1 for visible|
    """
    actor = Actor(*params[0:2])
    visibility = VisibilityState(int(params[4]))
    return VisibilityChange(
        timestamp=timestamp,
        actor=actor,
        visibility_category=VisibilityCategory.Nameplate,
        state=visibility
    )

Functions

def visibility_from_logline(timestamp: int, params: list[str]) ‑> Event

Parses a VisibilityChange event from an ACT log line

ACT Event ID (decimal): 34

Param layout from ACT

The first two params in every event is the ACT event ID and the timestamp it was parsed; the following table documents all the other fields.

Index	Type	Description
0	int	Source actor ID
1	string	Source actor name
2	int	Target actor ID
3	string	Target actor name
4	int	0 for invisible, 1 for visible

Expand source code

def visibility_from_logline(timestamp: Timestamp, params: list[str]) -> Event:
    """Parses a VisibilityChange event from an ACT log line

    ACT Event ID (decimal): 34

    ## Param layout from ACT

    The first two params in every event is the ACT event ID and the timestamp it was parsed; the following table documents all the other fields.

    |Index|Type|Description|
    |----:|----|:----------|
    |0    |int|Source actor ID|
    |1    |string|Source actor name|
    |2    |int|Target actor ID|
    |3    |string|Target actor name|
    |4    |int|0 for invisible, 1 for visible|
    """
    actor = Actor(*params[0:2])
    visibility = VisibilityState(int(params[4]))
    return VisibilityChange(
        timestamp=timestamp,
        actor=actor,
        visibility_category=VisibilityCategory.Nameplate,
        state=visibility
    )