2022-07-05 23:33:56 +00:00
<!DOCTYPE HTML>
< html lang = "en" >
< head >
<!-- Generated by javadoc (17) -->
2022-07-31 00:29:59 +00:00
< title > EventHandler (Scissors-API 1.19.1-R0.1-SNAPSHOT API)< / title >
2022-07-05 23:33:56 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta name = "description" content = "declaration: package: org.bukkit.event, annotation type: EventHandler" >
< meta name = "generator" content = "javadoc/ClassWriterImpl" >
< link rel = "stylesheet" type = "text/css" href = "../../../stylesheet.css" title = "Style" >
< link rel = "stylesheet" type = "text/css" href = "../../../script-dir/jquery-ui.min.css" title = "Style" >
< link rel = "stylesheet" type = "text/css" href = "../../../jquery-ui.overrides.css" title = "Style" >
< script type = "text/javascript" src = "../../../script.js" > < / script >
< script type = "text/javascript" src = "../../../script-dir/jquery-3.5.1.min.js" > < / script >
< script type = "text/javascript" src = "../../../script-dir/jquery-ui.min.js" > < / script >
< / head >
< body class = "class-declaration-page" >
< script type = "text/javascript" > v a r p a t h t o r o o t = " . . / . . / . . / " ;
loadScripts(document, 'script');< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
< div class = "flex-box" >
< header role = "banner" class = "flex-header" >
< nav role = "navigation" >
<!-- ========= START OF TOP NAVBAR ======= -->
< div class = "top-nav" id = "navbar-top" >
< div class = "skip-nav" > < a href = "#skip-navbar-top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< ul id = "navbar-top-firstrow" class = "nav-list" title = "Navigation" >
< li > < a href = "../../../index.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "nav-bar-cell1-rev" > Class< / li >
2022-07-26 04:26:54 +00:00
< li > < a href = "class-use/EventHandler.html" > Use< / a > < / li >
2022-07-05 23:33:56 +00:00
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../index-all.html" > Index< / a > < / li >
< li > < a href = "../../../help-doc.html#class" > Help< / a > < / li >
< / ul >
< / div >
< div class = "sub-nav" >
< div >
< ul class = "sub-nav-list" >
< li > Summary: < / li >
< li > Field | < / li >
< li > < a href = "#annotation-interface-optional-element-summary" > Optional< / a > | < / li >
< li > Required< / li >
< / ul >
< ul class = "sub-nav-list" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#annotation-interface-element-detail" > Element< / a > < / li >
< / ul >
< / div >
< div class = "nav-list-search" > < label for = "search-input" > SEARCH:< / label >
< input type = "text" id = "search-input" value = "search" disabled = "disabled" >
< input type = "reset" id = "reset-button" value = "reset" disabled = "disabled" >
< / div >
< / div >
<!-- ========= END OF TOP NAVBAR ========= -->
< span class = "skip-nav" id = "skip-navbar-top" > < / span > < / nav >
< / header >
< div class = "flex-content" >
< main role = "main" >
<!-- ======== START OF CLASS DATA ======== -->
< div class = "header" >
< div class = "sub-title" > < span class = "package-label-in-type" > Package< / span > < a href = "package-summary.html" > org.bukkit.event< / a > < / div >
< h1 title = "Annotation Interface EventHandler" class = "title" > Annotation Interface EventHandler< / h1 >
< / div >
< section class = "class-description" id = "class-description" >
< hr >
< div class = "type-signature" > < span class = "annotations" > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Target.html" title = "class or interface in java.lang.annotation" class = "external-link" > @Target< / a > (< a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title = "class or interface in java.lang.annotation" class = "external-link" > METHOD< / a > )
< a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Retention.html" title = "class or interface in java.lang.annotation" class = "external-link" > @Retention< / a > (< a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title = "class or interface in java.lang.annotation" class = "external-link" > RUNTIME< / a > )
< / span > < span class = "modifiers" > public @interface < / span > < span class = "element-name type-name-label" > EventHandler< / span > < / div >
< div class = "block" > An annotation to mark methods as being event handler methods< / div >
< / section >
< section class = "summary" >
< ul class = "summary-list" >
<!-- =========== ANNOTATION INTERFACE OPTIONAL MEMBER SUMMARY =========== -->
< li >
< section class = "member-summary" id = "annotation-interface-optional-element-summary" >
< h2 > Optional Element Summary< / h2 >
< div class = "caption" > < span > Optional Elements< / span > < / div >
< div class = "summary-table three-column-summary" >
< div class = "table-header col-first" > Modifier and Type< / div >
< div class = "table-header col-second" > Optional Element< / div >
< div class = "table-header col-last" > Description< / div >
< div class = "col-first even-row-color" > < code > boolean< / code > < / div >
< div class = "col-second even-row-color" > < code > < a href = "#ignoreCancelled()" class = "member-name-link" > ignoreCancelled< / a > < / code > < / div >
< div class = "col-last even-row-color" >
< div class = "block" > Define if the handler ignores a cancelled event.< / div >
< / div >
< div class = "col-first odd-row-color" > < code > < a href = "EventPriority.html" title = "enum class in org.bukkit.event" > EventPriority< / a > < / code > < / div >
< div class = "col-second odd-row-color" > < code > < a href = "#priority()" class = "member-name-link" > priority< / a > < / code > < / div >
< div class = "col-last odd-row-color" >
< div class = "block" > Define the priority of the event.< / div >
< / div >
< / div >
< / section >
< / li >
< / ul >
< / section >
< section class = "details" id = "annotation-interface-element-detail" >
< ul class = "details-list" >
<!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== -->
< li >
< section class = "member-details" >
< h2 > Element Details< / h2 >
< ul class = "member-list" >
< li >
< section class = "detail" id = "priority()" >
< h3 > priority< / h3 >
< div class = "member-signature" > < span class = "return-type" > < a href = "EventPriority.html" title = "enum class in org.bukkit.event" > EventPriority< / a > < / span > < span class = "element-name" > priority< / span > < / div >
< div class = "block" > Define the priority of the event.
< p >
First priority to the last priority executed:
< ol >
< li > LOWEST
< li > LOW
< li > NORMAL
< li > HIGH
< li > HIGHEST
< li > MONITOR
< / ol > < / div >
< dl class = "notes" >
< dt > Returns:< / dt >
< dd > the priority< / dd >
< / dl >
< dl class = "notes" >
< dt > Default:< / dt >
< dd > NORMAL< / dd >
< / dl >
< / section >
< / li >
< li >
< section class = "detail" id = "ignoreCancelled()" >
< h3 > ignoreCancelled< / h3 >
< div class = "member-signature" > < span class = "return-type" > boolean< / span > < span class = "element-name" > ignoreCancelled< / span > < / div >
< div class = "block" > Define if the handler ignores a cancelled event.
< p >
If ignoreCancelled is true and the event is cancelled, the method is
not called. Otherwise, the method is always called.< / div >
< dl class = "notes" >
< dt > Returns:< / dt >
< dd > whether cancelled events should be ignored< / dd >
< / dl >
< dl class = "notes" >
< dt > Default:< / dt >
< dd > false< / dd >
< / dl >
< / section >
< / li >
< / ul >
< / section >
< / li >
< / ul >
< / section >
<!-- ========= END OF CLASS DATA ========= -->
< / main >
< / div >
< / div >
< / body >
< / html >
