SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias LogString

    LogString: Message<"soulfire.v1.LogString"> & {
        botAccountId?: string;
        botAccountName?: string;
        id: string;
        instanceId?: string;
        instanceName?: string;
        level?: string;
        loggerName?: string;
        message: string;
        personal: boolean;
        scriptId?: string;
        timestamp?: Timestamp;
    }

    Represents a single log entry from the SoulFire logging system. Log entries can be associated with specific instances, bots, or scripts, or they can be personal messages directed to a specific user.

    Type Declaration

    • OptionalbotAccountId?: string

      The UUID of the bot account this log is associated with, if any. Present when the log was generated by or about a specific bot.

      from field: optional string bot_account_id = 4;

    • OptionalbotAccountName?: string

      Human-readable name of the bot account, if available. Provided as a convenience to avoid requiring additional lookups.

      from field: optional string bot_account_name = 8;

    • id: string

      Unique identifier for this log entry. Format is "{timestamp_millis}-{counter}" where counter is an incrementing integer to ensure uniqueness within the same millisecond.

      from field: string id = 1;

    • OptionalinstanceId?: string

      The UUID of the instance this log is associated with, if any. Present when the log was generated in the context of a specific attack instance.

      from field: optional string instance_id = 3;

    • OptionalinstanceName?: string

      Human-readable name of the instance, if available. Provided as a convenience to avoid requiring additional lookups.

      from field: optional string instance_name = 7;

    • Optionallevel?: string

      The log level (e.g., "INFO", "WARN", "ERROR", "DEBUG", "TRACE", "FATAL"). Corresponds to Log4j2 log levels.

      from field: optional string level = 11;

    • OptionalloggerName?: string

      The name of the logger that produced this log entry (e.g., "com.soulfiremc.server.SomeClass"). Useful for filtering and debugging purposes.

      from field: optional string logger_name = 10;

    • message: string

      The formatted log message content. This is the fully formatted output including any Minecraft formatting codes and exception stack traces if present.

      from field: string message = 2;

    • personal: boolean

      Indicates whether this is a personal message directed to a specific user. Personal messages are only visible to the target user and are not stored in the log history.

      from field: bool personal = 6;

    • OptionalscriptId?: string

      The UUID of the script this log is associated with, if any. Present when the log was generated during script execution.

      from field: optional string script_id = 5;

    • Optionaltimestamp?: Timestamp

      The timestamp when this log entry was created.

      from field: google.protobuf.Timestamp timestamp = 9;

    from message soulfire.v1.LogString

    Settings
    Member Visibility