pbmarks (v1.2)

• Index

Contents

• Functions
• Tables

Modules

• settings.lua
• api.lua
• formspec.lua
• chat.lua

Module api.lua

Personal Bookmarks API

Functions

pbmarks.get (pname, idx)	Retrieves a bookmark.
pbmarks.set (pname, idx, label, pos)	Sets bookmark information.
pbmarks.unset (pname, idx)	Unsets bookmark information.

Tables

BookmarkTable

Bookmark table.

Functions

pbmarks.get (pname, idx)

Retrieves a bookmark.

Parameters:

• pname string Player name referenced for bookmark.
• idx int Index of bookmark to retrieve.

Returns:

table BookmarkTable.

pbmarks.set (pname, idx, label, pos)

Sets bookmark information.

Parameters:

• pname string Player name referenced for bookmark.
• idx int Index of bookmark to be set.
• label string Label used to identify bookmark.
• pos table Position to be bookmarked.

pbmarks.unset (pname, idx)

Unsets bookmark information.

Parameters:

• pname string Player name referenced for bookmark.
• idx int Index of bookmark to be unset.

Tables

BookmarkTable

Bookmark table.

Fields:

• label string Label used to identify bookmark.
• pos table Position table with x,y,z coordinates (example: pos = {x=7, y=8, z=-12}).