-
Notifications
You must be signed in to change notification settings - Fork 17
/
Module.java
144 lines (126 loc) · 4.51 KB
/
Module.java
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*
* Copyright 2011 Tyler Blair. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and contributors and should not be interpreted as representing official policies,
* either expressed or implied, of anybody else.
*/
package com.griefcraft.scripting;
import com.griefcraft.lwc.LWC;
import com.griefcraft.scripting.event.LWCAccessEvent;
import com.griefcraft.scripting.event.LWCBlockInteractEvent;
import com.griefcraft.scripting.event.LWCCommandEvent;
import com.griefcraft.scripting.event.LWCDropItemEvent;
import com.griefcraft.scripting.event.LWCProtectionDestroyEvent;
import com.griefcraft.scripting.event.LWCProtectionInteractEvent;
import com.griefcraft.scripting.event.LWCProtectionRegisterEvent;
import com.griefcraft.scripting.event.LWCProtectionRegistrationPostEvent;
import com.griefcraft.scripting.event.LWCProtectionRemovePostEvent;
import com.griefcraft.scripting.event.LWCRedstoneEvent;
import com.griefcraft.scripting.event.LWCReloadEvent;
import com.griefcraft.scripting.event.LWCSendLocaleEvent;
/**
* This interface defines methods that modules may implement
*/
public interface Module {
// Results returned by methods
public enum Result {
ALLOW,
CANCEL,
DEFAULT
}
/**
* Called when the module is loaded
*/
public void load(LWC lwc);
/**
* Called when LWC reloads- e.g a config reload
*/
public void onReload(LWCReloadEvent event);
/**
* Find out the access level of a player to a protection
*
* @param event
*/
public void onAccessRequest(LWCAccessEvent event);
/**
* Called when a player drops an item
*
* @param event
*/
public void onDropItem(LWCDropItemEvent event);
/**
* Called when a player or console executes an LWC command
*
* @param event
*/
public void onCommand(LWCCommandEvent event);
/**
* Called when redstone interacts with a protection
*
* @param event
*/
public void onRedstone(LWCRedstoneEvent event);
/**
* Called when a protection is destroyed
*
* @param event
*/
public void onDestroyProtection(LWCProtectionDestroyEvent event);
/**
* Called when a valid protection is interacted with
*
* @param event
*/
public void onProtectionInteract(LWCProtectionInteractEvent event);
/**
* Called when an unprotected block is interacted with
*
* @param event
*/
public void onBlockInteract(LWCBlockInteractEvent event);
/**
* Called immediately before a protection is registered
*
* @param event
*/
public void onRegisterProtection(LWCProtectionRegisterEvent event);
/**
* Called after a protection is registered
*
* @param event
*/
public void onPostRegistration(LWCProtectionRegistrationPostEvent event);
/**
* Called after a protection is removed (the Protection class given is immutable.)
*
* @param event
*/
public void onPostRemoval(LWCProtectionRemovePostEvent event);
/**
* Called when LWC or another module sends a locale message to a player
*
* @param event
*/
public void onSendLocale(LWCSendLocaleEvent event);
}