Verb

class bTagScript.verb.Verb(verb_string: Optional[str] = None, *, limit: int = 2000)[source]

Bases: object

Represents the passed TagScript block.

Parameters
  • verb_string (Optional[str]) – The string to parse into a verb.

  • limit (int) – The maximum number of characters to parse.

declaration

The text used to declare the block.

Type

Optional[str]

parameter

The text passed to the block parameter in the parentheses.

Type

Optional[str]

payload

The text passed to the block payload after the colon.

Type

Optional[str]

Example

Below is a visual representation of a block and its attributes:

.. tagscript::

Normally {declaration(parameter):payload}

set_payload() None[source]

Set the payload

open_parameter(i: int) None[source]

Open the parameter

close_parameter(i: int) bool[source]

Close the parameter