Book Base item

Item defined in plugin/items/sh_book_base.lua

Part of Books

Defines the book_base base item that every book item derives from.

Using a book places it in the world as a cw_book entity owned by the player, and OnSetup turns the item's bookInformation text into the HTML shown by the cwViewBook panel. Books are in the Literature category and sold under the 3 access flag.

Summary

Methods

OnSetup()shared
Turns the book's bookInformation text into HTML for the book window.
OnUse(player, itemEntity)shared
Places the book as a cw_book owned by the player where they are looking, within 192 units.

Methods

ITEM:OnSetup()

shared gamemodes/cwhl2rp/plugins/books/plugin/items/sh_book_base.lua:60

Turns the book's bookInformation text into HTML for the book window.

Line breaks become <br> and tabs four non-breaking spaces.

ITEM:OnUse(player, itemEntity)

shared gamemodes/cwhl2rp/plugins/books/plugin/items/sh_book_base.lua:19

Places the book as a cw_book owned by the player where they are looking, within 192 units.

When used from the ground, the book takes the item entity's place and stays frozen if the item was.

Parameters

  • player
  • itemEntity

Returns

  • Boolean false when the spot is too far away

Defined in