Skip to content

Books Item Definition

Literature item system for the Lilia framework.

name

📋 Purpose

Sets the display name of the book item

⏰ When Called

During item definition

💡 Example Usage

    ITEM.name = "Medical Journal"

desc

📋 Purpose

Sets the description of the book item

⏰ When Called

During item definition

💡 Example Usage

    ITEM.desc = "A medical journal containing important information"

category

📋 Purpose

Sets the category for the book item

⏰ When Called

During item definition

💡 Example Usage

    ITEM.category = "itemCatLiterature"

model

📋 Purpose

Sets the 3D model for the book item

⏰ When Called

During item definition

💡 Example Usage

    ITEM.model = "models/props_lab/bindergraylabel01b.mdl"

contents

📋 Purpose

Sets the HTML content to display when reading the book

⏰ When Called

During item definition (used in Read function)

💡 Example Usage

    ITEM.contents = "<h1>Chapter 1</h1><p>This is the content...</p>"

health

📋 Purpose

Sets the health value for the item when it's dropped as an entity in the world

⏰ When Called

During item definition (used when item is spawned as entity) Notes: - Defaults to 100 if not specified - When the item entity takes damage, its health decreases - Item is destroyed when health reaches 0 - Only applies if ITEM.CanBeDestroyed is true (controlled by config)

💡 Example Usage

    ITEM.health = 250  -- Item can take 250 damage before being destroyed

Complete Examples

The following examples demonstrate how to use all the properties and methods together to create complete definitions.

Complete Item Example

Below is a comprehensive example showing how to define a complete item with all available properties and methods.

            ITEM.name = "Medical Journal"

            ITEM.desc = "A medical journal containing important information"

            ITEM.category = "itemCatLiterature"

            ITEM.model = "models/props_lab/bindergraylabel01b.mdl"

            ITEM.contents = "<h1>Chapter 1</h1><p>This is the content...</p>"

            ITEM.health = 250  -- Item can take 250 damage before being destroyed

    -- Basic item identification
        ITEM.name = "Medical Journal"                                    -- Display name shown to players
        ITEM.desc = "A medical journal containing important information" -- Description text
        ITEM.category = "itemCatLiterature"                              -- Category for inventory sorting
        ITEM.model = "models/props_lab/bindergraylabel01b.mdl"           -- 3D model for the book
        ITEM.health = 100                                                -- Health when dropped (default: 100)
        ITEM.contents = "<h1>Chapter 1: Basic Medicine</h1><p>This journal contains essential medical knowledge...</p>"  -- HTML content displayed when reading