# コンポーネント引数

# 概要

すべて sp_ で始まる
Function 型は _fn で終わる
Web Components 経由の場合、複雑な型は使えない
- Hash 型などは JSON5 風の文字列として指定する
- 内部で JSON5 形式としてパースする
- Hash は正確には Object 型のこと

# Level 1

# `sp_mode`

Type: view | play | edit
Default: view

モード

値	意味	用途
view	再生	棋譜を再生するときに使う
play	操作	CPUとの対戦や、一連の指し手で棋譜を作成するのに使う
edit	編集	詰将棋や課題局面の作成に使う

# `sp_body`

Type: String
Default: null

盤面に反映する棋譜を指定する

SFEN, KIF, BOD に対応する
棋譜のコンテンツを渡す (URLではない)
再生モード専用ではない
モードに関係なく sp_turn と合わせて盤面を変化させるのに使う
不整合な形式の棋譜を渡してもエラーを出したりはしない
何が起きるかわからないので本当に正しい形式だけを渡してほしい

# `sp_turn`

Type: Number
Default: -1

開始局面を指定する

棋譜には表示したい局面のの情報が含まれていないためこれで指定する
負の値は最終局面から数えた局面になるため -1 は一番最後(終了図)の局面になる
例えば -2 は終了図の1つ過去の局面になる

# `sp_viewpoint`

Type: black | white
Default: black

視点

後手または上手視点にするには white を指定する
.sync 対応

値	視点
black	☗
white	☖

# `sp_controller`

Type: Boolean
Default: false

コントローラーを表示するか？

局面を変更するボタンが合わさったコンポーネントのこと

# `sp_slider`

Type: Boolean
Default: false

スライダーを表示するか？

再生モード時には表示しておくと指定の局面に移動しやすい
操作モード時にも表示できるけどガチ対局するときは消しておいた方がよい
編集モード時には設定に関係なく表示しない

# `sp_piece_variant`

Type: nureyon | paper | zuan | portella
Default: nureyon

駒の種類

SVG な駒はどんなに巨大化してもぼやけない
PNG な駒も元の解像度が高いので拡大してもそれほど気にならない

値	名称	形式	影	特徴
none	なし			見えない
nureyon	ぬれよん	SVG		見やすいゴシック体の一文字
paper	紙面風	SVG		明朝体・裏面赤
zuan	図案駒	PNG		ユニバーサルデザイン
portella	Portella	PNG	✅	美麗

# `sp_board_variant`

Type: none | wood_normal | wood_bright
Default: none

盤のテクスチャ

基本なしでよい
そのとき盤面の色は --sp_board_color で変更できる
木目を指定するときはリアル駒(Portella)のときだけにしよう
- デフォルメした駒と木目の組み合わせは調和しない

値	名前
none	なし
wood_normal	普通の木目
wood_bright	明るい木目

# Level 2

# `sp_layout`

Type: horizontal | vertical
Default: horizontal

駒台・名前・時間の表示場所を決める

値	配置
horizontal	横長	デスクトップ向け
vertical	縦長	スマホ向け

# `sp_mobile_vertical`

Type: Boolean
Default: true

画面幅が狭いとき自動的に縦配置に切り替えるか？

初期値を横配置にしているときに関係してくる
言い替えると画面幅が広いときに横配置に切り替えるかの設定でもある

# `sp_preset`

Type: String
Default: null

手合割(初期配置)の指定非推奨

sp_mode="edit" と合わせて sp_preset="詰将棋" とすれば相手玉だけがある状態で始まる
sp_body があるのでこのパラメータは要らない

# `sp_overlay_nav`

Type: Boolean
Default: false

再生モードのときの盤上の左右をクリックして動かせるようにするか？

有効にすると再生しやすくなるが駒を動かせなくなる
天王山をクリックすると反転する

# `sp_coordinate`

Type: Boolean
Default: false

座標を表示するか？

# `sp_coordinate_variant_v`

Type: kanji | number | alphabet
Default: kanji

右側面の座標の表記

値	表記
kanji	一..九
number	1..9
alphabet	a..i

# `sp_stand_gravity`

Type: bottom | top
Default: bottom

駒台を左右に配置したとき位置は上か下か？

下に寄せた方が対角線的に綺麗な配置に見える
一方、右上だけで詰将棋を作るなら上に寄せた方が持駒が見やすくなるなどの利点もある
両方を☗視点で上に寄せるのはいまのところ対応していない

値	寄せる方向
bottom	下
top	上

# `sp_stand_flip`

Type: Boolean
Default: false

相手側を反転するか？

値	意味
false	上下左右対象 (おすすめ)
true	相手側の持駒も自分目線になる

# `sp_name_direction`

Type: horizontal | vertical
Default: horizontal

名前の縦横書き切り替え

左右配置時のみ有効になる
紙面風にしたいときかつ「先手」「後手」とだけ表記するなら縦書きにするのがてっとり早い

値	意味
horizontal	横書き
vertical	縦書き

WARNING

半角アルファベットを縦書きにすると横になってしまう。その場合は、横書きのまま1文字ずつ <br> を入れて縦にした方がいいかもしれない

# `sp_player_info`

Type: Hash
Default: null

対局者と時間の情報をハッシュ形式で渡す

例:

{
  black: {
    name: "六代大橋宗銀",
    time: "12:34"
  },
  white: {
    name: "伊藤印達",
    time: "56:78",
  },
}

# `sp_turn_show`

Type: Boolean
Default: false

再生モード時に手数の表示をするか？

盤の上部に表示する
それをクリックすると入力フィールドに切り替わって局面(手数)を入力できる
しかしこれまでの経験からしてあまり使うことはなかった
スライダーを表示していれば現在の手数がわかるからというのもある
スマホの場合、無駄に一行分画面を使ってしまう

# `sp_active_side_viewpoint`

Type: Boolean
Default: false

起動時に手番側の視点にするか？

言い替えると「指定の局面の手番が☖なら反転するか？」という意味になる

# `sp_comment`

Type: Boolean
Default: true

KIF形式の棋譜にコメントが含まれていれば盤の下に表示するか？

# `sp_human_side`

Type: none | both | black | white
Default: both

操作モードで操作できる側を制限する

自分が先手でCPUが後手だったとき both だと後手の考慮中に先手が後手の駒を動かせてしまう
そんなとき black に変更しておけば先手は後手の駒を動かせなくなる
つまりCPUと対戦するときの人間側を指定しておけばよい

値	操作できる側
none	なし
both	☗☖
black	☗
white	☖

# `sp_balloon`

Type: Boolean
Default: true

対局者名の下に駒数スタイルと同じ背景色を置くか？

# Level 3

# `sp_lift_cancel_action`

Type: standard | reality | rehold
Default: standard

盤上の持ち上げた駒のキャンセル方法

共通してマウスの右クリックやキーボードのESCキーでもキャンセルできる
もともとリアル志向を初期値としていたが将棋ウォーズに慣れきってしまった者たちにはハードルが高かったため初期値を変更した。が、やっぱり戻すかもしれない
持駒にも同じ挙動を適用するべきだができていない

値	挙動	タイプ
standard	初心者向け移動できないセルに移動したとき	将棋ウォーズぴよ将棋
reality	リアル志向元の位置に戻す	昔の共有将棋盤
rehold	合理的キャンセルと同時に駒を持つ	lishogi

TIP

lishogi の方法は常に駒を持った状態になってしまって駒を離せないので使いにくい仕様だと見ていたが、よく考えてみればこれから何かの手を指そうとしているときに、駒を持ち替えることはあっても、駒を離した状態に戻らないといけなくなることはないので、実はとても合理的な仕様だった。

# `sp_view_mode_piece_movable`

Type: Boolean
Default: true

再生モードでも駒を動かせるようにするか？

継盤のような動作をする
本筋は破壊しない
コントローラーやスライダーで手数を動かすと本筋の前後に戻る
- 駒を動かす直前の局面に戻るべき？要検討

# `sp_board_cell_left_click_disabled`

Type: Boolean
Default: false

盤上のセルをクリックしたときの通常処理を無効化するか？要検討
この機能は sp_view_mode_piece_movable を false するのでいい気がしている

# `sp_location_click_behavior`

Type: flip | nop
Default: flip

☗☖をクリックしたときの挙動

値	挙動
flip	視点を反転する
nop	何もしない

# `sp_sfen_show`

Type: Boolean
Default: false

盤面の下にSFENを表示するか？削除予定

# `sp_mounted_focus_to_slider`

Type: Boolean
Default: false

起動時にスライダーがあればフォーカスするか？

スライダーがなければ何もしない
再生モードで最初からスライダーにフォーカスしておけばそのまま左右ボタンで局面が切り替えることができて利用者に優しいUIになる
スマホだととくにメリットはない

WARNING

フォーカスする際にブラウザがスクロールしてしまう場合がある

# `sp_operation_disabled`

Type: Boolean
Default: false

全体の操作を無効化するか？

画像のような状態であってほしいときに使う

# `sp_piece_stand_blank_then_hidden`

Type: Boolean
Default: false

持駒がないときは駒台を非表示にするか？

開戦していない局面を狭い領域にたくさん表示したいときだけ使う

# `sp_board_cell_class_fn`

Type: Function
Default: null

盤面のセルのクラスを決める

座標を引数にして呼び出すので例えば次のようにすると55の地点に「天王山」のクラスを付与する

:sp_board_cell_class_fn="p => p.human_x === 5 && p.human_y === 5 && '天王山'"

Web Components 版では内部で eval しているため動作する

# `sp_double_click_threshold_ms`

Type: Number
Default: 350

編集モードで駒を反転するときのダブルクリックと認識する時間(ms)

ネイティブなダブルクリック判定を入れると通常のクリック判定が遅れるため自力判定している

# `sp_key_event_capture`

Type: Boolean
Default: false

スライダーにフォーカスしていなくても左右キーで手数を動かせるようにするか？非推奨

WARNING

副作用あり。他のプログラムの操作を奪ってしまうかもしれないため基本は false にしておいた方がよい

# 合法手

# `sp_legal_move_only`

Type: Boolean
Default: true

操作モードで合法手のみに絞るか？

false にすると？
- 禁じ手や手番の制約がなくなる
- ということは自分の手番で相手の駒を操作できる
- それを利用して後手のときも先手の駒を動かせばずっと先手側を操作できるので先手だけの囲いの手順の棋譜(SFENに限る)を作ったりするのが簡単になる
  - SFENに限る理由は駒の種類を見ていないため

# `sp_piece_auto_promote`

Type: Boolean
Default: true

操作モードで死に駒になるときは自動的に成るか？

有効にすると「桂」を「11」に飛んだとき自動的に成る
完全なリアル対局をイメージしたいときは false にする

# `sp_my_piece_only_move`

Type: Boolean
Default: true

操作モードで動かせるのは自分の駒だけとするか？要検討

sp_human_side と機能が重複しているような気がする

# `sp_my_piece_kill_disabled`

Type: Boolean
Default: true

操作モードでは味方の駒を取れないようにするか？

# 反則

# `sp_illegal_validate`

Type: Boolean
Default: true

操作モードで反則の判定をするか？

反則の種類
- 二歩
- 王手放置
- 駒ワープ
- 死に駒

# `sp_illegal_cancel`

Type: Boolean
Default: false

反則判定にひっかかったあと反則を無かったことにするか？

無かったことにしてもイベントで反則を知ることはできる
有効にすると基本的な反則の操作はできなくなる
有効にすると将棋ウォーズのようになる

# Web Components 専用

# `sp_pass_style`

Type: String Hash
Default: null

style 属性の代替

shogi-player-wc::part(root) {} を使わず直接タグにCSS変数を渡したいときに使う
Web Components では style を指定しても内側(Shadow Dom)には届かないため引数を設けている
また Web Components 経由ではネイテイブなハッシュは渡せないのでJSON5形式文字列で指定する
最終的に ShogiPlayer.vue コンポーネントの style に渡す

<shogi-player-wc
  sp_pass_style="{'--sp_board_color': 'LightSkyBlue'}"
  ></shogi-player-wc>

# `sp_pass_css`

Type: String
Default: null

Shadow DOM 内に指定のCSSを渡す自己責任

Shadow DOM 内でCSSは隔離される。これは Web Components が他のWebページやWebアプリとの完全な分離を保証するために必要な機能である。だがWeb開発者にとっては制約となる場合もある。その制約を回避する禁じ手がこれ。
ShogiPlayer.vue コンポーネントの内側で style タグを生成してそのコンテンツとする

例えばこれで盤のスタイルを自由に変えられるが後に BoardTexture の名前は変わるかもしれない

<shogi-player-wc
 sp_pass_css=".BoardTexture { background-color: LightSkyBlue }"
></shogi-player-wc>

# 盤と特定のセルに着色し、盤駒に影をつける例

<!DOCTYPE html>
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <script defer src="https://cdn.jsdelivr.net/npm/shogi-player@1.1.17"></script>
</head>
<body>
  <shogi-player-wc
    sp_pass_css="
      :host {
        --sp_board_color: LightSkyBlue;
      }
      .place_7_6, .place_2_6 {
        background-color: LightPink;
      }
      .BoardTexture, .PieceObject {
        filter: drop-shadow(4px 4px 4px hsla(0 0% 0% / 0.5));
      }
    "
    ></shogi-player-wc>
</body>
</html>

単体で開く

# `sp-pass-props`

Type: String
Default: null

v-bind 属性の代替

Web Components + Vue 3 専用
Vue.js 2 で作成した Web Components を Vue 3 と組み合わせたとき snake_case なパラメータ名を持つ値が渡せない問題がある
いまのところ、これを回避する方法がないため代替パラメータを用意した
ここだけ例外的に kebab-case で書かないといけない
JSON5 形式の文字列としてパースする
型変換は JSON5 のパーサーに任せている
- Boolean 型は "true" ではなく true と書く
- Hash も Hash 型としてそのまま記述する
  - 文字列として書いてもよいがエスケープがものすごく大変になる
JSON5 なのでコメントも書ける

<shogi-player-wc
  sp-pass-props="{
    sp_body: 'position sfen lnsgkgsnl/1r7/ppppppppp/9/9/9/PPPPPPPPP/1B5R1/LNSGKGSNL w - 1 moves 7a6b 7g7f 5c5d 2g2f',
    sp_controller: true,
    // CSS変数を渡す場合 ← コメント可
    sp_pass_style: {
      '--sp_board_color': 'blue',
    },
  }"
  ></shogi-player-wc>

# Development

# `sp_dev_tools`

Type: Boolean
Default: false

開発ツールを起動するか？

# `sp_dev_tools_position`

Type: left | right | top | bottom
Default: left

開発ツールの画面位置

# `sp_dev_tools_group`

開発ツールのタブ

# `sp_device`

Type: touch | desktop
Default: null

デバイスを強制的に指定する

自動判別するので基本そのままでよい
デバイス判別によって駒を動かすときの挙動が変わる

値	意味	挙動
touch	タッチパネル操作	持ち上げた駒がマウスポインタについてこないかわりに移動元の色で駒を持ち上げたのがわかるようにする
desktop	マウス操作	持ち上げた駒がマウスポインタについてくる

# `sp_layer`

Type: Boolean
Default: false

レイヤーを確認するか？

# `sp_debug`

Type: Boolean
Default: false

デバッグモードを有効にするか？

# `sp_event_log`

Type: Boolean
Default: false

イベント情報を JavaScript コンソールに出力するか？

# Slot

# `sfen_part`

引数: sfen, xcontainer

sp_sfen_show のときに表示する sfen の部分非推奨

# コンポーネント引数

# 概要

# Level 1

# sp_mode

# sp_body

# sp_turn

# sp_viewpoint

# sp_controller

# sp_slider

# sp_piece_variant

# sp_board_variant

# Level 2

# sp_layout

# sp_mobile_vertical

# sp_preset

# sp_overlay_nav

# sp_coordinate

# sp_coordinate_variant_v

# sp_stand_gravity

# sp_stand_flip

# sp_name_direction

# sp_player_info

# sp_turn_show

# sp_active_side_viewpoint

# sp_comment

# sp_human_side

# sp_balloon

# Level 3

# sp_lift_cancel_action

# sp_view_mode_piece_movable

# sp_board_cell_left_click_disabled

# sp_location_click_behavior

# sp_sfen_show

# sp_mounted_focus_to_slider

# sp_operation_disabled

# sp_piece_stand_blank_then_hidden

# sp_board_cell_class_fn

# sp_double_click_threshold_ms

# sp_key_event_capture

# 合法手

# sp_legal_move_only

# sp_piece_auto_promote

# sp_my_piece_only_move

# sp_my_piece_kill_disabled

# 反則

# sp_illegal_validate

# sp_illegal_cancel

# Web Components 専用

# sp_pass_style

# sp_pass_css

# 盤と特定のセルに着色し、盤駒に影をつける例

# sp-pass-props

# Development

# sp_dev_tools

# sp_dev_tools_position

# sp_dev_tools_group

# sp_device

# sp_layer

# sp_debug

# sp_event_log

# Slot

# sfen_part

# `sp_mode`

# `sp_body`

# `sp_turn`

# `sp_viewpoint`

# `sp_controller`

# `sp_slider`

# `sp_piece_variant`

# `sp_board_variant`

# `sp_layout`

# `sp_mobile_vertical`

# `sp_preset`

# `sp_overlay_nav`

# `sp_coordinate`

# `sp_coordinate_variant_v`

# `sp_stand_gravity`

# `sp_stand_flip`

# `sp_name_direction`

# `sp_player_info`

# `sp_turn_show`

# `sp_active_side_viewpoint`

# `sp_comment`

# `sp_human_side`

# `sp_balloon`

# `sp_lift_cancel_action`

# `sp_view_mode_piece_movable`

# `sp_board_cell_left_click_disabled`

# `sp_location_click_behavior`

# `sp_sfen_show`

# `sp_mounted_focus_to_slider`

# `sp_operation_disabled`

# `sp_piece_stand_blank_then_hidden`

# `sp_board_cell_class_fn`

# `sp_double_click_threshold_ms`

# `sp_key_event_capture`

# `sp_legal_move_only`

# `sp_piece_auto_promote`

# `sp_my_piece_only_move`

# `sp_my_piece_kill_disabled`

# `sp_illegal_validate`

# `sp_illegal_cancel`

# `sp_pass_style`

# `sp_pass_css`

# `sp-pass-props`

# `sp_dev_tools`

# `sp_dev_tools_position`

# `sp_dev_tools_group`

# `sp_device`

# `sp_layer`

# `sp_debug`

# `sp_event_log`

# `sfen_part`