Etkinlik Nedenleri
Etkinlikler, oyun eylemlerine ek mantık eklemek için harikadır. Ama yanında etkinliğin meydana gelmesine cause olmuş (neden olmuş) olmayan bağlamların sağlanmasının dezavantajları vardır. Cause nesnesi geliştirmeye ve etkinlik hakkında ek bağlamsal bilgi almaya olanak verir. Bu bağlamsal bilgi etkinlik dinleyicisinin davranışına göre şekillenmek için kullanılabilir.
Örneğin, bir dünya koruma eklentisi, hangi oyuncunun, oyuncuların etkinliğin iptal olup olmaması gerektiğine karar verebilmelerinden önce ChangeBlockEvent meydana gelmesine neden olduğu bilgisine ihtiyaç duyar. Farklı kaynak koşulları için alt olayların kalabalık yaratmasının geleneksel rotasını takip etmektense bu bilgi etkinliğin Cause
’unda sağlanmıştır.
Her etkinlik, etkinliğin niçin bitirildiğine dair bilgi için sorgulanabilen ``Cause``nesnesi sağlar. Couse nesnesi bir etkinlikten sadece Event#getCause() çağrılarak kurtarılmış olabilir.
Cause and Context
The Cause
object contains two distinct sets of information, the cause stack and the EventContext.
The cause stack of the event are the direct causes captured in order of importance. There are no names attached to the objects in the cause stack.
The event context contains extra information surrounding the event. Contexts are attached to keys but have no order, they are all equally important.
As an example, if a sheep owned by a player eats some grass, the most direct cause of this is the sheep. The
player would be in the EventContext
as the EventContextKeys#OWNER, giving event consumers
that additional information about how the event has come about, but would not necessarily be within the
direct cause itself.
Another example that you may need to watch out for is if you simulate a player. The simulated player may not be
in the direct cause, as the player being simulated may not have been involved in the action, however, the player
would be in the EventContext
under the EventContextKeys#PLAYER_SIMULATED
Retrieving Objects from the Direct Cause
Yapısal olarak, bir Cause
nesnesi, nesnelerin sonraki listesini içerebilir. Burda tartıştığımız bir Neden nesnesinden bilgi telafi etmenin bir çok metodu vardır, lütfen tam listeleme için Javadocs. bakınız.
Not
Bir neden içindeki bu nesneler, ilk nesnenin etkinliğin en doğrudan nedeni olması gibi düzenlenmiştir, ve sonraki nesnelerin önemi gittikçe azalıyor ve/veya sonraki nesneler sadece içerik bilgisi sağlıyor olabilir.
Cause#root()`bir neden içindeki ilk nesneyi döndürür. Bu nesne etkinliğin en doğrudan veya direkt nedenidir. Bir ``Cause`’un boş olmama ihtimalinden itibaren, root
yapmak garantidir.
Cause#first(Class) returns the first object in the cause chain whose type is either the same as or is a
subtype of the given class. For example, given a cause which contained a player followed by an entity
[Player, Entity, ...]
@Listener
public void onEvent(ExampleCauseEvent event) {
Cause cause = event.getCause(); // [Player, Entity]
Optional<Player> firstPlayer = cause.first(Player.class); // 1
Optional<Entity> firstEntity = cause.first(Entity.class); // 2
}
Both optionals would contain the player object as its type directly matched request for a Player type and it matched the request for an Entity type as Player is a subtype of Entity.
Cause#last(Class) neden zinciri tür eşleşmesinde son değeri döndürmesi dışında Cause#first(Class)
ile benzeşir.
Yukarıdaki örnekten devam ederek, eğer Cause#last(Class)
çağırmayı değiştirmek yerine ilk seçenek hala oyuncu nesnesini içerebilirdi ama ikinci seçenek şimdi nedenin ikinci pozisyonunda bizim geçmiş olduğumuz varlık içerebilirdi.
Cause#containsType(Class) boolean değeri döndür ve neden zincirinin geliştirilen türde nesne eşleşmesi içerip içermediğini kontrol etmek için kullanılabilir.
Cause#all() sadece daha avantajlı kullanıma izin veren neden içindeki bütün projeleri döndürür.
Event Context
Sometimes the ordering of objects within the cause isn’t enough to get the proper idea of what an object represents in
relation to the event. This is where EventContext comes in. The event context allows objects to be
associated with unique names, in the form of EventContextKeys, allowing them to be easily identified and
requested. Some examples of use cases for named causes is the Notifier of a ChangeBlockEvent.Grow or the
Source
of a DamageEntityEvent.
Unlike the cause stack, which makes no guarantees as to the objects contained witin it, an object associated with a EventContextKey is guaranteed to be of the type specified by the key.
Retrieving a entry from the context of a cause
@Listener
public void onGrow(ChangeBlockEvent.Grow event) {
Optional<User> notifier = event.getCause().getContext().get(EventContextKeys.NOTIFIER);
}
This example makes use of EventContext#get(EventContextKey) which can be used to retrieve the expected object
associated with a name if it is present within the context. Additionally EventContext#asMap() provides
a Map<EventContextKey<?>, Object>
which can be used to find all present EventContextKey
s and their associated
objects.
Not
Some common identifying names for EventContextKey
s are present as static fields in the
EventContextKeys
class.
Creating Custom Causes
Creating a cause is easy, but depends on whether you are creating your cause on the main server thread or async.
Not
Nesneler değişmez olduğundan, bir kez oluşturulduğunda değiştirilemezler.
Using the CauseStackManager
Uyarı
The CauseStackManager
only works on the main server thread. If you call it from a
different thread, an IllegalStateException
will be thrown. Ensure you are on the main
server thread before calling methods on the CauseStackManager
.
If you are creating your event on the main thread, then use the CauseStackManager, which can
be found at Sponge#getCauseStackManager(). The CauseStackManager
tracks the potential
causes of events as the game runs, allowing for easy retrieval of the current Cause
without effort.
To see the current cause, call CauseStackManager#getCurrentCause(). You may notice that your
plugin’s PluginContainer is already in the returned Cause
, as plugins are one of the
objects tracked by the manager. Using the CauseStackManager
for creating causes removes the
need for boilerplate-like code where you supply objects like your plugin container, so that you can
concentrate on adding your own causes.
Before adding your own causes, you should push a cause stack frame to the manager. Adding a frame acts as a saved state, when you are done with your causes, the removal of the frame returns the manager to its original state.
Tüyo
Adding a frame to the CauseStackManager does not remove what is already in the manager, so anything
that is in the cause stack and contexts before a stack frame is added will be there afterwards. You
can verify this by calling Sponge.getCauseStackManager().getCurrentCause()
before and after the
frame is pushed.
For example, if the cause stack contains a PluginContainer
and a CommandSource
when a frame
is pushed, they will remain on the stack and will form part of the Cause
if one is obtained from
the frame.
For example, if you were to fire an event that was simulating another player in a sudo like command,
you may want to add the player you are acting as in the cause and the GameProfile
of the player that you are
simulating in the context (as the simulated player is not directly responsible for the event being fired.)
Creating a custom Cause with the CauseStackManager
In this example, the variables would be populated, the cause would contain the playerToSimulate
as
the root cause, the sourceRunningSudo
as the second object in the cause and the GameProfile
as the EventContextKeys#PLAYER_SIMULATED context, in addition to anything already in the
CauseStackManager
. Your event code would be at the bottom of the method.
CommandSource sourceRunningSudo = ...;
Player playerToSimulate = ...;
try (CauseStackManager.StackFrame frame = Sponge.getCauseStackManager().pushCauseFrame()) {
frame.pushCause(sourceRunningSudo);
frame.pushCause(playerToSimulate);
frame.addContext(EventContextKeys.PLAYER_SIMULATED, playerToSimulate.getProfile());
Cause cause = frame.getCurrentCause();
}
Note that the last item you push to the cause stack will be the root of the Cause
as
stacks are “last in, first out” (LIFO) structures.
Tüyo
For more information about the stack data type and why the order matters, see the Stack javadocs or this Wikipedia article.
Using the Cause Builder
If you are creating an event that does not fire on the main thread, you cannot use the
CauseStackManager
. Instead, you will need to create a Cause
object manually.
Creating a cause object is easy using the Cause.Builder. You can obtain a
builder by calling Cause.builder()
. To add a cause to the builder, use the
Cause.Builder#append(Object) method, but note that unlike the CauseStackManager
,
the first element you add will be the root, not the last.
If you wish to add contexts, there is a separate builder for those, the
EventContext.Builder, accessed by calling EventContext#builder()
.
The EventContext
can then be added using the Cause.Builder#build(EventContext)
when
you have finished building the Cause
up.
Taking the previous example, this is how we would build it using the cause builder.
Creating a custom Cause with the Cause and EventContext builders
Note that in this example, the variables would be populated, and that the first entry appended to the cause would be the root cause.
CommandSource sourceRunningSudo = ...;
Player playerToSimulate = ...;
PluginContainer plugin = ...;
EventContext context = EventContext.builder()
.add(EventContextKeys.PLAYER_SIMULATED, playerToSimulate.getProfile())
.add(EventContextKeys.PLUGIN, plugin)
.build();
Cause cause = Cause.builder()
.append(playerToSimulate)
.append(sourceRunningSudo)
.append(plugin)
.build(context);
Think carefully about what information to include in your cause.
If you’re firing an event from your plugin which is usually triggered through other means,
it is a good idea to include your PluginContainer
in the cause so other plugins know
that the event comes from your plugin. If you are firing the event on behalf of a player
due to some action it’s usually a good idea to include that player in the cause.