(追従と修正) |
|||
1行目: | 1行目: | ||
このページは[http://www.minecraftforge.net/wiki/ Minecraft Forge Wiki]の[http://www.minecraftforge.net/wiki/Forge_Events Forge Events]の訳です。 | このページは[http://www.minecraftforge.net/wiki/ Minecraft Forge Wiki]の[http://www.minecraftforge.net/wiki/Forge_Events Forge Events]の訳です。 | ||
= Forge Events = | = Forge Events = | ||
− | 新しいForge Event | + | 新しいForge Event Busシステムは、全てイベントによって構成される。このイベントシステムの使い方は[http://www.minecraftforum.net/topic/1419836-131-forge-4x-events-howto/ AtomicStryker's guide on How To Use ForgeEvents]で紹介されている |
− | @ForgeSubscribe | + | @ForgeSubscribe アノテーションはメソッドをイベントシステムに関連付け、パラメータ(引数)はどのイベントを受け取るかを決定する |
− | + | パラメータにスーパークラス(継承元のクラス)を利用した場合、サブクラス(継承したクラス)のイベントも受け取ることになる。以下は利用可能なイベントの一覧である | |
− | + | 但し、全てのサブクラスは当然スーパークラスのプロパティを参照することが出来るので、ここではそのようなフィールドについては触れない。 | |
=== Version === | === Version === | ||
− | + | このイベント一覧は現在Minecraft Forge 6.4.0 build 397に基づいている | |
== CommandEvent == | == CommandEvent == | ||
− | + | コマンドが送信された時に発生する | |
'''フィールド''' | '''フィールド''' | ||
;ICommand command | ;ICommand command | ||
− | : | + | :送信されたコマンド。即ち、ゲームのチャットで/のあとに入力された、あるいはコンソールで入力された最初の語句 |
;ICommandSender sender | ;ICommandSender sender | ||
:コマンドの送信者 | :コマンドの送信者 | ||
;String[] parameters | ;String[] parameters | ||
− | : | + | :コマンドと一緒に送信されたパラメーター。即ち、スペースによって区切られた語句 |
;Throwable exception | ;Throwable exception | ||
:イベントがキャンセルされたときに投げられる例外 | :イベントがキャンセルされたときに投げられる例外 | ||
31行目: | 31行目: | ||
'''フィールド''' | '''フィールド''' | ||
;Entity entity | ;Entity entity | ||
− | : | + | :このイベントを発生させたエンティティ |
+ | |||
+ | === EntityJoinWorldEvent === | ||
+ | エンティティがワールドに加わった時に発生する | ||
+ | |||
+ | '''フィールド''' | ||
+ | ;World world | ||
+ | :ワールドのインスタンス | ||
=== PlaySoundAtEntityEvent === | === PlaySoundAtEntityEvent === | ||
− | + | エンティティの位置で音声が再生される時に発生する | |
'''フィールド''' | '''フィールド''' | ||
;String name | ;String name | ||
− | : | + | :再生される音声の名前 |
;float volume | ;float volume | ||
− | : | + | :音声のボリューム |
;float pitch | ;float pitch | ||
− | : | + | :音声のピッチ。例:動物の子供の鳴き声 |
+ | |||
+ | == ItemEvent == | ||
+ | [[#EntityEvent]]のサブクラス<br> | ||
+ | サブクラスによってのみ発生する | ||
+ | |||
+ | '''フィールド''' | ||
+ | ;EntityItem entityItem | ||
+ | :イベントに関連するEntityItem | ||
+ | |||
+ | === ItemExpireEvent === | ||
+ | EntityItemが寿命に達した時に発生する。このイベントをキャンセルすると、アイテムの死亡済フラグがセットされワールドから消滅することを阻止できる。キャンセルによってエンティティの寿命が(extraLifeの分だけ)延びる | ||
+ | <!-- 死亡フラグと書きたかったw --> | ||
+ | |||
+ | '''フィールド''' | ||
+ | ;int extraLife | ||
+ | :イベントがキャンセルされた時にエンティティの寿命に追加される時間 | ||
+ | |||
+ | === ItemTossEvent === | ||
+ | プレイヤーがインベントリからアイテムを捨てた(Qキーを押した、インベントリのGUIの外側にアイテムをD&Dした)時に発生する。このイベントをキャンセルすると、アイテムはワールドには現れないがインベントリ及びシステムからは消滅する | ||
+ | |||
+ | '''フィールド''' | ||
+ | ;EntityPlayer entityPlayer | ||
+ | :アイテムを捨てたプレイヤー | ||
== LivingEvent == | == LivingEvent == | ||
[[#EntityEvent]]のサブクラス<br> | [[#EntityEvent]]のサブクラス<br> | ||
− | + | ここに直接記載されないクラス: [[#PlayerEvent]]<br> | |
− | + | サブクラスによってのみ発生する | |
'''フィールド''' | '''フィールド''' | ||
54行目: | 84行目: | ||
=== LivingAttackEvent === | === LivingAttackEvent === | ||
− | + | 生きたエンティティが攻撃される時に発生する | |
'''フィールド''' | '''フィールド''' | ||
;DamageSource source | ;DamageSource source | ||
− | : | + | :ダメージの原因 |
;int amount | ;int amount | ||
:攻撃によって受けたダメージ | :攻撃によって受けたダメージ | ||
− | source.getEntity() | + | source.getEntity()は、攻撃元がエンティティならそのエンティティを、そうでないならnullを返す<br> |
− | このイベントをevent.setCanceled(true) | + | このイベントをevent.setCanceled(true)を呼び出してキャンセルすると、攻撃を中止できる |
=== LivingDeathEvent === | === LivingDeathEvent === | ||
− | + | 生きたエンティティのHPが0になる時に発生する | |
'''フィールド''' | '''フィールド''' | ||
;DamageSource source | ;DamageSource source | ||
− | : | + | :死の一撃の原因 |
;int amount | ;int amount | ||
− | : | + | :攻撃によって受けるダメージ |
− | source.getEntity() | + | source.getEntity()は、攻撃元がエンティティならそのエンティティを、そうでないならnullを返す<br> |
− | このイベントをevent.setCanceled(true) | + | このイベントをevent.setCanceled(true)を呼び出してキャンセルすると、このエンティティは死なない |
=== LivingDropsEvent === | === LivingDropsEvent === | ||
− | + | 生きたエンティティが死に、アイテムをドロップする時に発生する | |
'''フィールド''' | '''フィールド''' | ||
88行目: | 118行目: | ||
:バニラではLooting(ドロップ増加)のエンチャントに反映される | :バニラではLooting(ドロップ増加)のエンチャントに反映される | ||
;boolean recentlyHit | ;boolean recentlyHit | ||
− | : | + | :エンティティが死亡前に攻撃されたかどうか |
;int specialDropValue | ;int specialDropValue | ||
− | : | + | :Lootingレベルで引かれる0~200のランダムな数値。バニラでは、レアドロップする場合5未満となる |
− | source.getEntity() | + | source.getEntity()は、攻撃元がエンティティならエンティティを、そうでないならnullを返す<br> |
− | このイベントをevent.setCanceled(true) | + | このイベントをevent.setCanceled(true)を呼び出してキャンセルすると、エンティティはアイテムをドロップしない |
=== LivingFallEvent === | === LivingFallEvent === | ||
+ | エンティティが落下した時に発生する | ||
+ | |||
+ | '''フィールド''' | ||
+ | ;float distance | ||
+ | :エンティティが落下した距離 | ||
+ | |||
=== LivingHurtEvent === | === LivingHurtEvent === | ||
+ | エンティティが何らかの有効なDamageSourceによって攻撃される時に発生する。以下の原因を含む: 炎、溶岩、溺死、飢え、サボテンとの接触、落下 など。 全ての攻撃元はnet.minecraft.src.DamageSourceを参照 | ||
+ | |||
+ | '''フィールド''' | ||
+ | ;DamageSource source | ||
+ | :ダメージの原因(種類) | ||
+ | ;int amount | ||
+ | :負うダメージ | ||
+ | |||
=== LivingSetAttackTargetEvent === | === LivingSetAttackTargetEvent === | ||
=== LivingSpecialSpawnEvent === | === LivingSpecialSpawnEvent === | ||
104行目: | 148行目: | ||
=== ArrowLooseEvent === | === ArrowLooseEvent === | ||
+ | === ArrowNockEvent === | ||
=== AttackEntityEvent === | === AttackEntityEvent === | ||
=== BonemealEvent === | === BonemealEvent === | ||
110行目: | 155行目: | ||
=== FillBucketEvent === | === FillBucketEvent === | ||
=== PlayerDestroyItemEvent === | === PlayerDestroyItemEvent === | ||
+ | === PlayerDropsEvent === | ||
+ | === PlayerInteractEvent === | ||
=== PlayerSleepInBedEvent === | === PlayerSleepInBedEvent === | ||
=== UseHoeEvent === | === UseHoeEvent === |
2012年12月13日 (木) 20:55時点における版
このページはMinecraft Forge WikiのForge Eventsの訳です。
目次
Forge Events
新しいForge Event Busシステムは、全てイベントによって構成される。このイベントシステムの使い方はAtomicStryker's guide on How To Use ForgeEventsで紹介されている
@ForgeSubscribe アノテーションはメソッドをイベントシステムに関連付け、パラメータ(引数)はどのイベントを受け取るかを決定する
パラメータにスーパークラス(継承元のクラス)を利用した場合、サブクラス(継承したクラス)のイベントも受け取ることになる。以下は利用可能なイベントの一覧である
但し、全てのサブクラスは当然スーパークラスのプロパティを参照することが出来るので、ここではそのようなフィールドについては触れない。
Version
このイベント一覧は現在Minecraft Forge 6.4.0 build 397に基づいている
CommandEvent
コマンドが送信された時に発生する
フィールド
- ICommand command
- 送信されたコマンド。即ち、ゲームのチャットで/のあとに入力された、あるいはコンソールで入力された最初の語句
- ICommandSender sender
- コマンドの送信者
- String[] parameters
- コマンドと一緒に送信されたパラメーター。即ち、スペースによって区切られた語句
- Throwable exception
- イベントがキャンセルされたときに投げられる例外
EntityEvent
すべてのエンティティに関するイベントのスーパークラス。サブクラスによってのみ発生する
フィールド
- Entity entity
- このイベントを発生させたエンティティ
EntityJoinWorldEvent
エンティティがワールドに加わった時に発生する
フィールド
- World world
- ワールドのインスタンス
PlaySoundAtEntityEvent
エンティティの位置で音声が再生される時に発生する
フィールド
- String name
- 再生される音声の名前
- float volume
- 音声のボリューム
- float pitch
- 音声のピッチ。例:動物の子供の鳴き声
ItemEvent
#EntityEventのサブクラス
サブクラスによってのみ発生する
フィールド
- EntityItem entityItem
- イベントに関連するEntityItem
ItemExpireEvent
EntityItemが寿命に達した時に発生する。このイベントをキャンセルすると、アイテムの死亡済フラグがセットされワールドから消滅することを阻止できる。キャンセルによってエンティティの寿命が(extraLifeの分だけ)延びる
フィールド
- int extraLife
- イベントがキャンセルされた時にエンティティの寿命に追加される時間
ItemTossEvent
プレイヤーがインベントリからアイテムを捨てた(Qキーを押した、インベントリのGUIの外側にアイテムをD&Dした)時に発生する。このイベントをキャンセルすると、アイテムはワールドには現れないがインベントリ及びシステムからは消滅する
フィールド
- EntityPlayer entityPlayer
- アイテムを捨てたプレイヤー
LivingEvent
#EntityEventのサブクラス
ここに直接記載されないクラス: #PlayerEvent
サブクラスによってのみ発生する
フィールド
- EntityLiving entityLiving
- このイベントと関連付けられたエンティティ。同じオブジェクトがEntityEventのentityに入る
LivingAttackEvent
生きたエンティティが攻撃される時に発生する
フィールド
- DamageSource source
- ダメージの原因
- int amount
- 攻撃によって受けたダメージ
source.getEntity()は、攻撃元がエンティティならそのエンティティを、そうでないならnullを返す
このイベントをevent.setCanceled(true)を呼び出してキャンセルすると、攻撃を中止できる
LivingDeathEvent
生きたエンティティのHPが0になる時に発生する
フィールド
- DamageSource source
- 死の一撃の原因
- int amount
- 攻撃によって受けるダメージ
source.getEntity()は、攻撃元がエンティティならそのエンティティを、そうでないならnullを返す
このイベントをevent.setCanceled(true)を呼び出してキャンセルすると、このエンティティは死なない
LivingDropsEvent
生きたエンティティが死に、アイテムをドロップする時に発生する
フィールド
- DamageSource source
- 死の原因
- ArrayList<EntityItem> drops
- エンティティがドロップするアイテムのリスト。追加および削除が可能
- int lootingLevel
- バニラではLooting(ドロップ増加)のエンチャントに反映される
- boolean recentlyHit
- エンティティが死亡前に攻撃されたかどうか
- int specialDropValue
- Lootingレベルで引かれる0~200のランダムな数値。バニラでは、レアドロップする場合5未満となる
source.getEntity()は、攻撃元がエンティティならエンティティを、そうでないならnullを返す
このイベントをevent.setCanceled(true)を呼び出してキャンセルすると、エンティティはアイテムをドロップしない
LivingFallEvent
エンティティが落下した時に発生する
フィールド
- float distance
- エンティティが落下した距離
LivingHurtEvent
エンティティが何らかの有効なDamageSourceによって攻撃される時に発生する。以下の原因を含む: 炎、溶岩、溺死、飢え、サボテンとの接触、落下 など。 全ての攻撃元はnet.minecraft.src.DamageSourceを参照
フィールド
- DamageSource source
- ダメージの原因(種類)
- int amount
- 負うダメージ
LivingSetAttackTargetEvent
LivingSpecialSpawnEvent
PlayerEvent
#LivingEventのサブクラス
ArrowLooseEvent
ArrowNockEvent
AttackEntityEvent
BonemealEvent
EntityInteractEvent
EntityItemPickupEvent
FillBucketEvent
PlayerDestroyItemEvent
PlayerDropsEvent
PlayerInteractEvent
PlayerSleepInBedEvent
UseHoeEvent
MinecartEvent
#EntityEventのサブクラス
MinecartCollisionEvent
MinecartInteractEvent
MinecartUpdateEvent
WorldEvent
ChunkEvent
ChunkDataEvent
#ChunkEventのサブクラス