Project Zomboid Scripts API Reference

Welcome to the Project Zomboid Scripts API Reference. This documentation provides references of script blocks, their properties and parameters. For more information about Scripts, see this wiki page.

This documentation is auto-generated from the PZ Scripts Data. To contribute or suggest improvements, please refer to the main repository’s contribution guidelines.

Documentation Structure

Contents:

• Script Blocks Reference
  • alias
  • anim
  • animation
  • animationsMesh
  • area
  • attachment
  • blend
  • BlendWhiteList
  • Categories
  • character_profession_definition
  • character_trait_definition
  • clip
  • clock
  • component
    • component ContextMenuConfig
    • component CraftBench
    • component CraftBenchSounds
    • component CraftRecipe
    • component DryingCraftLogic
    • component Durability
    • component FluidContainer
    • component Resources
    • component SpriteConfig
    • component SpriteOverlayConfig
    • component UiConfig
    • component WallCoveringConfig
  • components
  • container
  • contextEntry
  • CopyFrame
  • CopyFrames
  • CraftLogic
  • craftRecipe
  • data
  • door
  • energy
  • entity
  • evolvedrecipe
  • face
  • fixing
  • fluid
  • Fluids
  • group
  • hand
  • imports
  • inputs
  • ISBaseComponentPanel
  • ISTableLayoutCell
  • item
  • itemMapper
  • layer
  • layers
  • lightbar
  • lua
  • mannequin
  • model
  • module
  • option
  • outputs
  • overlayMapper
  • part
  • passenger
  • physics
  • physicsHitReaction
  • physicsShape
  • Poison
  • position
  • progress
  • Properties
  • ragdoll
  • ROOT-Blends
  • ROOT-MapBaseXML
  • ROOT-MapInfo
  • ROOT-ModInfo
  • ROOT-Rules
  • ROOT-SandboxOptions
  • ROOT-Scripts
  • ROOT-TileGeometry
  • ROOT-TMXconfig
  • rule
  • skin
  • sound
  • spriteModel
  • style
  • switchSeat
  • table
  • template
  • tile
  • tileset
  • timedAction
  • vehicle
  • vehicleEngineRPM
  • wheel
  • whitelist
  • window
  • xuiSkin