issun 0.10.0

A mini game engine for logic-focused games - Build games in ISSUN (一寸) of time
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! Plugin control primitives
//!
//! Defines the API for MODs to control ISSUN plugins at runtime.

use serde::{Deserialize, Serialize};

/// Actions that can be performed on plugins
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum PluginAction {
    /// Enable a plugin
    Enable,

    /// Disable a plugin
    Disable,

    /// Set plugin parameter
    SetParameter {
        key: String,
        value: serde_json::Value,
    },

    /// Trigger a custom hook
    TriggerHook {
        hook_name: String,
        data: serde_json::Value,
    },
}

/// Plugin control command
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PluginControl {
    pub plugin_name: String,
    pub action: PluginAction,
}

impl PluginControl {
    /// Create a control command to enable a plugin
    pub fn enable(plugin_name: impl Into<String>) -> Self {
        Self {
            plugin_name: plugin_name.into(),
            action: PluginAction::Enable,
        }
    }

    /// Create a control command to disable a plugin
    pub fn disable(plugin_name: impl Into<String>) -> Self {
        Self {
            plugin_name: plugin_name.into(),
            action: PluginAction::Disable,
        }
    }

    /// Create a control command to set a parameter
    pub fn set_param(
        plugin_name: impl Into<String>,
        key: impl Into<String>,
        value: impl Into<serde_json::Value>,
    ) -> Self {
        Self {
            plugin_name: plugin_name.into(),
            action: PluginAction::SetParameter {
                key: key.into(),
                value: value.into(),
            },
        }
    }

    /// Create a control command to trigger a hook
    pub fn trigger_hook(
        plugin_name: impl Into<String>,
        hook_name: impl Into<String>,
        data: serde_json::Value,
    ) -> Self {
        Self {
            plugin_name: plugin_name.into(),
            action: PluginAction::TriggerHook {
                hook_name: hook_name.into(),
                data,
            },
        }
    }
}