Freeze Module

The Freeze Module provides player freezing functionality to temporarily restrict player movement and actions.

🚀 Features

Core Functionality

Player Freezing - Block player movement
Chat Freeze - Block player chat
Visual Feedback - Show freeze status to player
Staff Notifications - Notify staff of freeze actions
Freeze History - Track freeze actions

Advanced Features

Selective Freezing - Freeze specific players
Global Chat Freeze - Freeze all player chat
Freeze Messages - Customizable freeze notifications
Staff Tracking - Who froze/unfroze players

📋 Commands

Freeze Commands

`/freeze <player>`

Freeze a player (block movement).

Permission: zenith.freeze

Parameters:

player - Player name to freeze

Examples:

/freeze Player123
/freeze Player456

`/unfreeze <player>`

Unfreeze a player.

Permission: zenith.freeze

Parameters:

player - Player name to unfreeze

Examples:

/unfreeze Player123
/unfreeze Player456

Chat Freeze Commands

`/chatfreeze`

Toggle global chat freeze.

Permission: zenith.chatfreeze

Examples:

/chatfreeze  # Toggle chat freeze on/off

⚙️ Configuration

Module Settings

enabled: true

settings:
  chat-freeze: true
  visual-feedback: true
  freeze-message: "&#FF5555You are frozen! Reason: {reason}"
  unfreeze-message: "&#00FF00You have been unfrozen!"
  staff-notifications: true

Freeze Messages

messages:
  staff:
    freeze_success: "&#00FF00Player {player} has been frozen!"
    unfreeze_success: "&#00FF00Player {player} has been unfrozen!"
    chat_freeze_enabled: "&#FF5555Chat freeze has been enabled!"
    chat_freeze_disabled: "&#00FF00Chat freeze has been disabled!"

  player:
    frozen: "&#FF5555You are frozen! Reason: {reason}"
    unfrozen: "&#00FF00You have been unfrozen!"
    chat_frozen: "&#FF5555Chat is currently frozen!"

🔐 Permissions

Required Permissions

Permission	Description
`zenith.freeze`	Freeze/unfreeze players
`zenith.chatfreeze`	Toggle global chat freeze
`zenith.freeze.notifications`	Receive freeze notifications

Permission Examples

permissions:
  - zenith.freeze: true
  - zenith.chatfreeze: true
  - zenith.freeze.notifications: true

What they can do:

✅ Freeze/unfreeze players
✅ Toggle global chat freeze
✅ Receive notifications

permissions:
  - zenith.freeze: true
  - zenith.freeze.notifications: true

What they can do:

✅ Freeze/unfreeze players
✅ Receive notifications
❌ Toggle global chat freeze

permissions:
  - zenith.freeze: true

What they can do:

✅ Freeze/unfreeze players
❌ Toggle global chat freeze
❌ Receive notifications

📊 Database Schema

Freeze Table Structure

CREATE TABLE zn_freezes (
    id INT PRIMARY KEY AUTO_INCREMENT,
    player_uuid VARCHAR(36) NOT NULL,
    player_name VARCHAR(16) NOT NULL,
    staff_uuid VARCHAR(36) NOT NULL,
    staff_name VARCHAR(16) NOT NULL,
    reason TEXT,
    frozen_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    unfrozen_at TIMESTAMP NULL,
    active BOOLEAN DEFAULT TRUE
);

🔧 API Integration

Freeze via API

POST /zenith/api/freeze
Authorization: Bearer your-token-here

{
  "player": "Player123",
  "reason": "Investigation"
}

Unfreeze via API

POST /zenith/api/unfreeze
Authorization: Bearer your-token-here

{
  "player": "Player123",
  "reason": "Investigation complete"
}

🎮 Player Experience

What Players See

When frozen, players will see:

Movement blocked - Cannot move, jump, or fly
Visual feedback - Freeze message displayed
Command restrictions - Most commands disabled
Chat access - Can still chat (unless chat freeze active)

Staff Experience

Staff will see:

Success messages - Confirmation of freeze actions
Player status - Who is currently frozen
Notifications - Real-time freeze updates
History - Complete freeze log

🛠️ Troubleshooting

Common Issues

Issue: Freeze not working

Check if module is enabled
Verify permissions
Check player online status
Restart server if needed

Issue: Player can still move

Check freeze status in database
Verify player permissions
Check for permission bypasses
Ensure freeze handler is active

Issue: Chat freeze not working

Check chat freeze permission
Verify chat event handler
Check for conflicting plugins
Restart server if needed

Debug Mode

Enable debug mode for detailed logging:

debug:
  enabled: true
  console: true
  file: true

📈 Performance

Optimization Tips

Use MySQL/MariaDB for large servers
Regular database maintenance
Monitor freeze table size
Limit concurrent freezes

Monitoring

Track freeze frequency
Monitor freeze duration
Check staff activity
Review freeze reasons

Need help with the Freeze Module? Join our Discord: https://discord.gg/2qCMn6KHj4