Protection
概要
Protection は非推奨です。新機能は追加されず、v1.3 が最後の互換性リリースです。新しいプロジェクトでは、TypeWriter の公式 Region 拡張機能を使ってください。ドキュメントは docs.typewritermc.com にあります。このページは、すでに Protection を運用しているサーバーのために残されています。
Protection を使うと、TypeWriter の Web パネルでリージョンを定義し、フラグと呼ばれるルールを与えられます。リージョンは、アーティファクトに保存された直方体またはポリゴンの角柱で、優先度、オーナー、メンバー、任意の親リージョン、そして build、pvp、mob-spawning などのフラグのリストを持ちます。プレイヤーがリージョン内で行動すると、拡張機能はフラグに従って、その行動をキャンセルまたは変更します。
リージョンは TypeWriter のオブジェクトでもあります。プレイヤーがリージョンに入ったとき、または出たときにシーケンスを開始したり、リージョンでオーディエンスを絞り込んだり、リージョンでプレイヤーをグルーピングしたり、プレイヤーが内部にいるかを示すファクトを読み取ったり、BlueMap のマップ上にリージョンを表示したりできます。
機能
- 直方体とポリゴンのリージョン — ゲーム内でツールバーを使ってリージョンを描くか、WorldEdit の選択範囲をインポートします。
- ワールド全体のリージョン — グローバルアーティファクトで、2 つの高さの間のワールド全体をカバーします。
- 重なりと優先度 — リージョンは重なることができ、優先度が高いものから順に評価されます。
- 親リージョン — 子リージョンは、親のフラグ、オーナー、メンバーを継承します。
- 豊富なフラグ — 建築、戦闘、爆発、環境、移動、チャットをカバーする 99 個のフラグキー。
- オーナーとメンバー — これらのプレイヤーは、自分のリージョン内で制限されることがありません。
- リージョンイベント — 出入りのイベント、オーディエンスフィルター、グループ、ファクト。
- 調査ツール —
/typewriter protection inspect、info、flagsで、今立っている場所に適用されているフラグを確認できます。 - BlueMap のマーカー — 独自の色で、BlueMap 上にリージョンを表示します。
- PlaceholderAPI — プレイヤーの周囲のリージョンとそのフラグの値を読み取ります。
インストール
- TypeWriter がすでに必要としている PacketEvents をインストールします。
- 任意:
/typewriter protection import-weで選択範囲をインポートするには、WorldEdit または FastAsyncWorldEdit をインストールします。 - 任意:
mob-spawningフラグを Mythic のモブにも適用するために MythicMobs を、リージョンをマップ上に表示するために BlueMap をインストールします。 - 任意: プレースホルダーのために PlaceholderAPI をインストールします。
- Protection の JAR を
plugins/Typewriter/extensions/に置き、サーバーを再起動します。
はじめに
スポーン地点のエリアを、建築と PvP から保護する手順です。
- TypeWriter の Web パネルで manifest ページを開き、Protection Region Artifact を追加します。
artifactIdは生成されたままにしておきます。リージョンの形状が保存されます。 - Protection Region Definition を追加し、
artifactにアーティファクトをリンクします。priority(例:10)を設定します。 flagsに、キーがbuildで、真偽値が false のフラグを追加します。pvpも同じように追加します。false の真偽値フラグは、その行動を拒否します。- ページをパブリッシュします。
- ゲーム内で
/typewriter protection edit <definition>を実行します。ホットバーにツールバーが現れます。ブレイズロッドは見ているブロックに点を追加し、レッドストーンは最後の点を削除し、コンパスは直方体モードとポリゴンモードを切り替え、ライムの染料は選択を適用し、バリアはキャンセルします。直方体の場合は、対角の 2 つの角を追加して適用します。 - そのエリアに入って、ブロックを壊してみます。
/typewriter protection inspectで、何が適用されているかを確認できます。
WorldEdit で選択範囲を作り、/typewriter protection import-we <definition> を実行します。選択範囲が点に変換され、それを適用できます。
リージョンのオーナーとメンバー、そして typewriter.protection.bypass を持つプレイヤーは、そのリージョンのすべてのフラグを無視します。リストに載っていないプレイヤー、かつバイパス権限を持つオペレーターではないプレイヤーでテストしてください。
仕組み
リージョンは、その定義エントリが存在し、パブリッシュされている間だけ存在します。形状はアーティファクトに保存され、それ以外のすべては定義が保持します。
重なり。 複数のリージョンが同じ点を含むことがあります。それらは、priority が高いものから低いものへと順にチェックされます。真偽値フラグでは、1 つの false フラグだけで行動が拒否されます。build が true のリージョンは、優先度の低いリージョンによる拒否を取り消しません。何かを変更するフラグ(メッセージ、アクション、テレポート)は、それを定義した最初のリージョンによって適用されます。
継承。 parentRegion を持つリージョンは、その親のフラグも評価します。親のオーナーとメンバーは、子に追加されます。子は自身の priority を使い、自身の値が 0 の場合は親の値を使います。
リージョンの境界。 出入りは、プレイヤーが別のブロックに移動したとき、またはテレポートしたときに検出されます。リージョンの内部で参加したプレイヤーは、最初に動いたブロックで入場イベントを発生させます。
設定
メッセージと調査。 Protection Settings エントリを 1 つ追加すると、拒否された行動の表示方法を変更できます。チャット、アクションバー、ボスバー、MiniMessage のテンプレート({reason}、{reason_line}、{region}、{flag})、調査モードの更新間隔(inspectRefreshTicks、最低 5 ティック)、そして messages のコマンドメッセージの文章です。このエントリがない場合は、デフォルトが使われます。最初に見つかったエントリだけが読み取られます。
BlueMap。 リージョン定義で bluemapSettings.enabled をオンにすると、BlueMap にリージョンが描画されます。マーカーセット、線と塗りの色、ラベル({name}、{id}、{priority})、マーカーを押し出すか平面にするかを選べます。リージョンは、BlueMap の起動時と、リージョンが変更されるたびに同期されます。
オーナーとメンバー。 owners と members には、プレイヤーの UUID が入ります。addowner と addmember コマンドは、プレイヤー名を受け付け、そのプレイヤーがサーバーに認識されている場合は UUID を保存します。
フラグ
フラグは、リージョン定義の flags リストに追加します。各フラグは、キーと型付きの値を持ちます。ほとんどのフラグは真偽値で、false の値はその行動を拒否します。以下のフラグキーは、Web パネルとコマンドで使われるものです。
建築とインタラクション
| フラグ | false の値の効果 |
|---|---|
build | ブロックの破壊と設置をキャンセルします。block-break と block-place より先にチェックされます。 |
block-break, block-place | ブロックの破壊または設置をキャンセルします。 |
use | ドア、ボタン、レバー、フェンスゲート、トラップドア、看板、チェスト、樽、シュルカーボックス、かまど、金床、作業台などのステーション、レッドストーン部品、その他同様のブロックに対する右クリックをキャンセルします。 |
interact | 空中でのクリックを含む、すべてのプレイヤーのインタラクションをキャンセルします。注意して使ってください。 |
chest-access | コンテナ(チェスト、樽、シュルカーボックス、ホッパー、ディスペンサー、ドロッパー、かまど、醸造台)を開くことをキャンセルします。 |
sleep | ベッドの使用をキャンセルします。 |
lighter | 火打石と打ち金、火の玉の使用をキャンセルします。 |
vehicle-place, vehicle-destroy | トロッコとボートの設置、またはプレイヤーが乗り物を破壊することをキャンセルします。 |
entity-painting-destroy | プレイヤーが絵画と額縁を壊すことをキャンセルします。 |
crop-trampling | 農地が踏み荒らされることをキャンセルします。 |
pistons | ピストンがブロックをリージョンの内外へ動かすことをキャンセルします。 |
item-pickup, item-drop | アイテムの拾得またはドロップをキャンセルします。 |
戦闘とモブ
| フラグ | false の値の効果 |
|---|---|
pvp | プレイヤー同士のダメージをキャンセルします。 |
mob-damage | プレイヤー以外のエンティティによる、プレイヤーへのダメージをキャンセルします。 |
damage-animals | プレイヤーが動物を攻撃することをキャンセルします。 |
tnt-damage, firework-damage | TNT と爆発性のトロッコ、または花火によるダメージをキャンセルします。 |
mob-spawning | 理由を問わず、生物のスポーンをキャンセルします。MythicMobs がインストールされている場合は、MythicMobs にも適用されます。 |
btcmob-spawning, btcmob-damage | BTC Mobs がインストールされている場合の、BTC Mobs の生物に対する同様の効果。 |
exp-drops | リージョン内で倒されたモブは、経験値をドロップしません。 |
potion-splash | スプラッシュポーションがリージョンに着弾することをキャンセルします。 |
爆発と環境
| フラグ | false の値の効果 |
|---|---|
creeper-explosion, tnt | クリーパーの爆発、または TNT、TNT 付きトロッコ、リスポーンアンカーの爆発をキャンセルします。 |
ghast-fireball | 火の玉、ウィザースカル、ドラゴンの火の玉、ウィンドチャージの爆発をキャンセルします。 |
fire-spread | 火の延焼、ブロックの燃焼、溶岩や雷以外による着火をキャンセルします。 |
lava-fire, lightning | 溶岩による着火、および落雷と、それによる着火をキャンセルします。 |
lava-flow, water-flow | 溶岩または水がリージョンに流れ込むことをキャンセルします。 |
ice-melt, snow-melt | 氷または雪が溶けることをキャンセルします。 |
ice-form, snow-fall | 氷または雪が形成されることをキャンセルします。 |
frostwalker | 氷渡りによる氷の生成をキャンセルします。 |
leaf-decay, grass-growth, vine-growth | 葉の枯れ、草・菌糸・土の道・キノコの拡散、ツタの成長をキャンセルします。 |
enderman-grief, ravager-grief | エンダーマンとラヴェジャーによるブロックの変更をキャンセルします。 |
chunk-unload | true の値は、リージョンのチャンクを強制ロードしたままにします。 |
移動
| フラグ | 値 | 効果 |
|---|---|---|
entry, exit | 真偽値 | false の値は、リージョンへの出入りをブロックします。ブロックされたプレイヤーには、deniedEntry メッセージが表示されます。 |
entry-deny-action, exit-deny-action | アクション | プレイヤーが出入りしたとき、および出入りが拒否されたときに、プレイヤーに対して実行される TypeWriter のアクション。通常のロジックには、入場と退場のイベントエントリを使ってください。 |
ender-pearl | 真偽値 | false の値は、リージョンへのエンダーパールによるテレポートをキャンセルします。 |
fall-damage | 真偽値 | false の値は、落下ダメージをキャンセルします。 |
fly | 真偽値 | false の値は、リージョン内のプレイヤーの飛行をオフにします。 |
walk-speed, fly-speed | 数値 | 内部にいるプレイヤーの歩行速度または飛行速度を、0 から 1 の間で設定します。Bukkit のスケールで、0.2 が通常の歩行速度、0.1 が通常の飛行速度です。外に出るとデフォルトに戻ります。 |
glide | テキスト | deny はエリトラでの滑空と飛行の切り替えを止めます。allow と default は何もしません。 |
join-location | 位置 | リージョン内でログインまたはリスポーンしたプレイヤーは、この位置に移動されます。 |
プレイヤーの状態、チャット、コマンド
| フラグ | 値 | 効果 |
|---|---|---|
hunger | 真偽値 | false の値は、空腹度の減少を止めます。 |
heal-amount, heal-min-health, heal-max-health | 数値 | 最小体力と最大体力の間で、リージョン内のプレイヤーを、毎秒 heal-amount 体力ポイントずつ回復します。ダメージを受けると、回復は 5 秒間停止します。 |
item-durability | 真偽値 | true の値は、ツール、武器、防具の耐久値の減少を止めます。 |
send-chat, receive-chat | 真偽値 | false の値は、リージョンから送信されるメッセージ、またはリージョン内で受信するメッセージをブロックします。 |
chat-prefix, chat-suffix | テキスト | リージョンから送信されるチャットメッセージの前後に、テキストを追加します。 |
blocked-cmds, allowed-cmds | リスト | ブロックされる、または常に許可されるコマンド名(スラッシュなし)。* はすべてのコマンドをブロックします。allowed-cmds が優先されます。 |
worldedit | 真偽値 | true の値は、リージョン内のプレイヤーに対する WorldEdit のコマンドをブロックします。 |
この拡張機能では適用されないもの
次のフラグはリージョンに追加できますが、Protection 内にそれらに対して動作するものはありません。passthrough、teleport、godmode、nether-portals、entry-min-level、entry-max-level、permit-completely、mobtrap-use、blocked-effects、heal-delay、biome(バイオームは変更されません)、そして RPG 系のフラグ mana-regen、mana-drain、double-drop、grappling-hook、fishing、alchemy、enchanting-override、elytra-auto-switch、ground-item-glow、pistol、corruption、auction、backpack、wardrobe、profession、experience、gathering、resin です。
keep-inventory、keep-exp、invincible も、通常のプレイヤーには効果がありません。オーナー、メンバー、バイパス権限を持つプレイヤーにだけ作用します。
コマンド
すべてのコマンドは /typewriter(エイリアス /tw)のサブコマンドです。たとえば /typewriter protection list です。プレイヤーだけが使用でき、typewriter.protection が必要です。admin と記されたコマンドには typewriter.protection.admin が必要です。
| コマンド | 説明 |
|---|---|
/typewriter protection list | 読み込まれているリージョンを、優先度の高い順に一覧表示します。 |
/typewriter protection edit <definition> | ホットバーのツールバーを使って、ゲーム内でリージョンの描画を開始します。グローバルアーティファクトの場合は、アーティファクトの値がすぐに適用されます。 |
/typewriter protection apply | 現在の選択範囲を保存します。 |
/typewriter protection cancel | 現在の選択範囲をキャンセルします。 |
/typewriter protection remove <1-16> | 現在の選択範囲の点を 1 つ削除します。 |
/typewriter protection import-we <definition> | WorldEdit の選択範囲を、リージョンの点としてインポートします。 |
/typewriter protection info <region> | リージョンの形状、優先度、オーナー、メンバー、フラグを表示します。 |
/typewriter protection flags <region> | どのフラグが有効、継承、上書き、または継承によってブロックされているかを表示します。 |
/typewriter protection inspect | 今立っている場所のリージョンとフラグを、アクションバーとボスバーでライブ表示するかを切り替えます。 |
/typewriter protection teleport <region> | リージョンの中心(グローバルリージョンの場合はワールドのスポーン地点)にテレポートします。 |
/typewriter protection wand | Protection Wand という名前の棒を渡します。このリリースでは、これに反応するものはありません。 |
/typewriter protection setflag <region> <flag> <value>(admin) | メモリ上のフラグを変更します。 |
/typewriter protection clearflag <region> <flag>(admin) | メモリ上のフラグを消去します。 |
/typewriter protection addowner|removeowner|addmember|removemember <region> <player>(admin) | メモリ上のオーナーまたはメンバーを変更します。 |
/typewriter protection delete <region>(admin) | メモリからリージョンを削除します。 |
/typewriter protection reload(admin) | パブリッシュ済みのエントリから、リージョンを再読み込みします。 |
/typewriter protection migrate-from-worldguard(admin) | WorldGuard のリージョンの直方体の範囲を、試験的にインポートします。アーティファクトの識別と移行のページを参照してください。 |
setflag、clearflag、addowner、removeowner、addmember、removemember、delete は、エントリには書き込まれません。読み込まれているコピーを変更するだけで、再読み込みや再起動で変更は失われます。ほとんどのフラグはリージョン定義エントリから適用されるため、setflag では、build、pvp、その他ほとんどのフラグの動作は変わりません。フラグは Web パネルで編集し、パブリッシュしてください。
権限
| 権限 | 許可される内容 |
|---|---|
typewriter.protection | admin 専用ではない /typewriter protection コマンド。 |
typewriter.protection.admin | admin コマンド: フラグ、オーナー、メンバー、削除、再読み込み、WorldGuard からの移行。 |
typewriter.protection.bypass | すべてのリージョンで、すべてのフラグを無視します。 |
プレースホルダー
PlaceholderAPI のプレースホルダーは、%typewriter_regions:<path>% の形式です。プレイヤーの位置にあるリージョンを、優先度順に並べて読み取ります。primary は、その最初のものです。
| プレースホルダー | 返す値 |
|---|---|
%typewriter_regions:count% | プレイヤーを含むリージョンの数。 |
%typewriter_regions:list%, %typewriter_regions:list_names% | それらのリージョンの ID または名前(カンマ区切り)。 |
%typewriter_regions:stack% | 各リージョンの優先度と名前(| 区切り)。 |
%typewriter_regions:has:<id1>,<id2>% | プレイヤーが、列挙されたリージョンのいずれかにいれば true。 |
%typewriter_regions:primary% | 最も優先度の高いリージョンの名前。他のフィールドを得るには、:id、:name、:priority、:overlap_count、:parent、:parent_name、:owner_count、:member_count、:is_global、:depth、:path を追加します。 |
%typewriter_regions:active:<n>% | スタックの n 番目(1 から開始)のリージョンの、同じフィールド。例: %typewriter_regions:active:2:id%。 |
%typewriter_regions:flag:<flag>% | プライマリリージョンにおけるフラグの値。出所を知るには、:state、:source、:source_name を追加します。 |
%typewriter_regions:by_id:<region>:<field>% | 指定したリージョンのフィールド。例: %typewriter_regions:by_id:spawn:priority%。 |
%typewriter_regions:exists:<region>% | リージョンが存在すれば true。 |
%typewriter_regions:nearest% | 最小の角がプレイヤーに最も近いリージョン。同じフィールドが利用できます。 |
%typewriter_regions:can_build%, %typewriter_regions:can_interact% | 優先度順で、build(または interact)を設定している最初のリージョンがそれを false にしている場合は false、それ以外は true。 |
Region への移行
Protection には新機能が追加されないため、TypeWriter の公式 Region 拡張機能(ドキュメントは docs.typewritermc.com)への移行を計画してください。このページでは Region について説明しません。Region 自身のドキュメントに従ってください。
Protection には、リージョンを Region に変換するツールはありません。一般的な手順は次のとおりです。
/typewriter protection listでリージョンを一覧表示し、それぞれについて、形状、優先度、親、オーナーとメンバー、フラグ(/typewriter protection info <region>)を控えます。- 新しい拡張機能で各リージョンを再作成し、各フラグを、そちらの同等の設定に対応付けます。Protection のフラグには適用されないものもある(上記参照)ため、不要なものもあるかもしれません。
- サーバーのコピーで、オーナー、メンバー、バイパス権限の保持者ではないプレイヤーを使ってテストします。
- 新しいリージョンが期待どおりに動作したら、Protection のエントリと JAR を削除します。その前に、TypeWriter のページとアセットのバックアップを取ってください。
エントリ
9 件のエントリー（拡張機能のソースから生成）。
イベント2
- On Enter Protection RegionWhen a player enters a protection region
- On Exit Protection RegionWhen a player exits a protection region
ファクト1
- In Protection Region FactIf the player is in a protection region
オーディエンス1
- Protection Region AudienceFilter players based on if they are in a protection region
グループ1
- Protection Region GroupAll players grouped by protection regions
アーティファクト2
- Global Protection Region ArtifactPersistent data for a world-wide protection region
- Protection Region ArtifactPersistent data for a TypeWriter-managed protection region
マニフェスト2
- Protection SettingsConfiguration for protection tooling
- Region DefinitionProtection region definition
トラブルシューティング
フラグが何もしない。 フラグでそのフラグを確認してください。適用されないキーもあります。また、リージョンが保存されパブリッシュされていること、プレイヤーがオーナー、メンバー、typewriter.protection.bypass の保持者のいずれでもないこと、拒否系のフラグでは値が false に設定された真偽値であることも確認してください。
リージョンは存在するが、プレイヤーがその内部にいない。 形状はアーティファクトから来ます。アーティファクトのない定義や、選択範囲を一度も適用していないアーティファクトは、何もカバーしません。/typewriter protection edit <definition> を実行して選択範囲を適用し、/typewriter protection info <region> で確認してください。すべての点が同じワールドにある必要があり、直方体には 2 点、ポリゴンには 3 点が必要です。
選択用のツールバーが表示されない。 edit には、アーティファクトにリンクされた、パブリッシュ済みのリージョン定義が必要です。定義がアーティファクトにリンクされていないというメッセージが出る場合は、リンクしてください。グローバルアーティファクトにはツールバーがありません。アーティファクトに worlds、minY、maxY を設定してください。
/typewriter protection import-we で、選択範囲がない、またはアダプターがないと表示される。 WorldEdit または FastAsyncWorldEdit がインストールされていて、今いるワールドで選択範囲を作っている必要があります。
setflag の変更が消える。 このコマンドはメモリ上だけを変更します。フラグをリージョン定義に設定して、パブリッシュしてください。
WorldGuard からの移行でリージョンが作成されなかった。 移行は、リージョン定義、フラグ、オーナー、メンバーを作成しません。各リージョンの直方体の範囲だけを扱い、WorldGuard のリージョンは、最初に読み込まれたワールドを通じて読み取ります。定義は Web パネルで作成してください。
entry でプレイヤーがテレポートされない、またはブロックされない。 チェックは、プレイヤーが別のブロックに移動したとき、またはテレポートしたときに行われます。移動イベントやテレポートイベントなしでプレイヤーを動かすプラグインによる進入は、検出されません。
関連する拡張機能
- MythicMobs —
mob-spawningは、Mythic のモブにも適用されます。