addToInitiative/ja

From RPTools Wiki
Jump to navigationJump to search

Languages:  English  • 日本語

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

addToInitiative() Function

現在トークンイニシアチブパネルに追加する。追加パラメータにより、トークンとイニシアチブ値を指定できる。

Usage

addToInitiative()
addToInitiative(複製可否)
addToInitiative(複製可否, 値)
addToInitiative(複製可否, 値, ID)
addToInitiative(複製可否, 値, ID, 地図名)

パラメーター

  • 複製可否 - 偽値(初期値)の場合、トークンがすでにイニシアチブの一覧にある場合は追加しない。真(1)の場合、イニシアティブの一覧に追加の項目が追加される(つまり、同じトークンに対して複数のイニシアティブ項目が存在するようになる可能性がある)。
  • - 設定するイニシアチブの値。これを含めると、トークンがすでにイニシアチブ一覧に存在する場合でもイニシアチブが設定され、重複は許されない。
  • ID - イニシアチブに追加するトークンのID。初期値は 現在トークン

     Note: This parameter can only be used in a Trusted Macro

  • 地図名 - トークンを探すための地図の名称。初期値は現在の地図。
  • 戻り値 - イニシアティブに追加された場合は1を、追加されなかった場合は0を返す。

Example

以下の例では、現在トークンイニシアチブパネルに追加し、そのイニシアチブを設定した後、イニシアチブパネルを並べ替える方法をを示している。通常、現在トークンを追加するたびにイニシアチブパネルを並べ替える事はないが、ここではどのように行われるかを示すために行っている。
[h: addToInitiative()]
[h: setInitiative(1d20)]
[h: sortInitiative()]

See Also

Version Changes

  • 1.5.7 - ID地図名の任意パラメーターを追加。

Languages:  English  • 日本語