RollLogger: An abstract R6 class providing means to log strings in a list...

In SigurdJanson/cthulhu: Cthulhu Rolling App

Description

An abstract R6 class providing means to log strings in a list of entries.

An abstract R6 class providing means to log strings in a list of entries.

Active bindings

Length

Current length of the log

Methods

Public methods

• RollLogger$new()

• RollLogger$Log()

• RollLogger$AsHtml()

• RollLogger$print()

• RollLogger$clone()

---

Method new()

log The logged list

maxEntries Maximum allowed entries

Constructor

Usage

RollLogger$new(MaxEntries = 25)

Arguments

MaxEntries

Maximum allowed entries; default is 25

Returns

'invisible(self)'

---

Method Log()

Stores strings in the log.

Usage

RollLogger$Log(ToLog)

Arguments

ToLog

a string that represents the last roll or any other event.

Returns

'invisible(self)'

---

Method AsHtml()

Returns the log content as HTML string

Usage

RollLogger$AsHtml(Reverse = TRUE)

Arguments

Reverse

if 'TRUE' the recent entries are shown on top.

Returns

HTML output

---

Method print()

Prints the log

Usage

RollLogger$print(...)

Arguments

...

Arguments passed over to 'cat()'

Returns

'invisible(self)'

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RollLogger$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

SigurdJanson/cthulhu documentation built on Dec. 18, 2021, 2 p.m.