「BCDice/TRPGツールからの呼び出し方/ダイスロールのみ利用する場合」の版間の差分

提供: TRPGツール開発・運用Wiki
ナビゲーションに移動 検索に移動
(ページの作成:「BCDiceのダイスロール機能のみを利用する場合の呼び出し方をまとめる。 __TOC__ == ダイスロールを行う == BCDiceのダイスロー…」)
 
1行目: 1行目:
[[BCDice]]のダイスロール機能のみを利用する場合の呼び出し方をまとめる。
+
[[BCDice]]のダイスロール機能のみを利用する場合の、[[Ruby]]プログラムからの呼び出し方をまとめる。
  
 
__TOC__
 
__TOC__
  
== ダイスロールを行う ==
+
== BCDice関連ファイルを読み込む ==
 +
 
 +
BCDiceの機能を利用する前に、1回だけ関連ファイルを読み込む必要がある。BCDiceが配置されているディレクトリを読み込みパスに追加してから、BCDice関連ファイルを読み込む。
  
BCDiceのダイスロール機能を呼び出すための[[Ruby]]プログラムの概要を以下に示す。
 
 
<syntaxhighlight lang="ruby">
 
<syntaxhighlight lang="ruby">
 +
# BCDiceが配置されているディレクトリを読み込みパスに追加する
 
$LOAD_PATH.unshift('/path/to/BCDice/src')
 
$LOAD_PATH.unshift('/path/to/BCDice/src')
  
 
# BCDice関連ファイルを読み込む
 
# BCDice関連ファイルを読み込む
require 'bcdiceCore'
 
 
require 'diceBot/DiceBot'
 
require 'diceBot/DiceBot'
 
require 'diceBot/DiceBotLoader'
 
require 'diceBot/DiceBotLoader'
 +
require 'bcdiceCore'
 +
</syntaxhighlight>
 +
 +
== ダイスロールを行う ==
  
 +
BCDiceのダイスロール機能を呼び出すプログラムの概要を以下に示す。
 +
 +
<syntaxhighlight lang="ruby">
 
# ゲーム名(英数字、省略名でも可)
 
# ゲーム名(英数字、省略名でも可)
 
# * 省略名の例:DX(DoubleCross)、SW20(SwordWorld2.0)
 
# * 省略名の例:DX(DoubleCross)、SW20(SwordWorld2.0)
40行目: 48行目:
 
rolled_dice = bcdice.getRandResults
 
rolled_dice = bcdice.getRandResults
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
== 利用できるダイスボットの一覧を取得する ==

2019年6月27日 (木) 13:12時点における版

BCDiceのダイスロール機能のみを利用する場合の、Rubyプログラムからの呼び出し方をまとめる。

BCDice関連ファイルを読み込む

BCDiceの機能を利用する前に、1回だけ関連ファイルを読み込む必要がある。BCDiceが配置されているディレクトリを読み込みパスに追加してから、BCDice関連ファイルを読み込む。

# BCDiceが配置されているディレクトリを読み込みパスに追加する
$LOAD_PATH.unshift('/path/to/BCDice/src')

# BCDice関連ファイルを読み込む
require 'diceBot/DiceBot'
require 'diceBot/DiceBotLoader'
require 'bcdiceCore'

ダイスロールを行う

BCDiceのダイスロール機能を呼び出すプログラムの概要を以下に示す。

# ゲーム名(英数字、省略名でも可)
# * 省略名の例:DX(DoubleCross)、SW20(SwordWorld2.0)
game_title = 'DoubleCross'
# コマンド
command = '2DX+4@10'

# 新しいBCDiceインスタンスを作る
bcdice = BCDiceMaker.new.newBcDice

# ゲームを指定する
bcdice.setGameByTitle(game_title)
# BCDiceに送るメッセージ(コマンド)を指定する
bcdice.setMessage(command)
# ダイスロールの結果(出目)を返すように設定する
bcdice.setCollectRandResult(true)

# ダイスロールを行い、結果を受け取る
# * output:ダイスロールの結果(出目の合計など)を示すメッセージ
# * secret:シークレットダイスならばtrue、そうでなければfalse
output, secret = bcdice.dice_command

# 出目の情報を受け取る
# 2つの整数要素を持つ配列の配列として返ってくる
# * 返り値の例:[[3, 10], [7, 10]](10面ダイスの3、10面ダイスの7)
rolled_dice = bcdice.getRandResults

利用できるダイスボットの一覧を取得する