RPG_Athumaru_API [w]
追加したコメント機能が安定していない可能性ありにつき旧版も合わせて公開しておきます。
DOWNLOAD - 20200416
DOWNLOAD - 20200215
RPGアツマールAPIをCFから操作できるようにするエクステンションです
20200416
投稿されたコメントの取得、投稿したコメントの取得の追加
https://game.nicovideo.jp/atsumaru/games/gm12228?key=9c8f699a3b5a
20200215
スクリーンショット機能の調整
https://game.nicovideo.jp/atsumaru/games/gm11516?key=ee550faf75b4
※アツマール右上のカメラボタンも効くようになります
20190919
共有セーブが無い状態で共有セーブを取得しようとした際の処理の修正 *再度修正
共有セーブの削除機能の追加
20190728
新API ニコニ広告情報を取得する を、新たに追加
https://atsumaru.github.io/api-references/nicoad/
20190715
ＲＰＧアツマールで提供されているＡＰＩをほぼ組み込みました
作者情報を表示する
スコアボード・ランキング情報の取得（データとしての取得）
グローバルサーバー変数
共有セーブ
ユーザー情報にアクセスする
最近プレイしたユーザー情報を得る
シグナルを送信する ※ユーザー間で小さなデータ（信号）をやり取りできる機能
スクリーンショットの撮影
※そもそもCFではスクリーンショットボタンが効かないので動作不能かもしれません
サンプルURLは下部にあり
※取得までの流れについての注意
サンプルを見て頂けると解りますが
基本的に取得命令を実行したタイミングで問い合わせの通信が発生し、通信完了後にデータにアクセスできるようになります。
主に下記の形がそれになります
XXXXX_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
※HTML5ファイナルビルド確認済み
----------------------------------------------------------------------
■Conditions(緑色の即時条件)
InputComment
コメントが投稿された際に評価されます(データは２項式による取得へ)
ViewComments
コメントが表示された際に評価されます(データは２項式による取得へ)
----------------------------------------------------------------------
■Actions
DisplayScoreBoard
スコアボードを表示します（ボード番号を指定）
SetRecord
スコアボードにスコアを記録します
（ボード番号に値を記録）
OpenLink
外部サイトへの誘導
----------------------------------------------------------------------
□コメントシステム操作 (RPGアツマールAPI本家解説も参考に)
https://atsumaru.github.io/api-references/comment
ChangeScene
シーンを変更する
resetAndChangeScene
シーンの変更と状態のリセット
pushContextFactor
Contextを積み上げる
pushMinorContext
minorcontextを積み上げる
setContext
Contextを設定する
----------------------------------------------------------------------
□作者情報を表示する
https://atsumaru.github.io/api-references/creator-modal
displayCreatorInformationModal
パラメーターに0をセットすれば自分、他を入れれば他のユーザー情報を表示します
----------------------------------------------------------------------
□スクリーンショットの撮影
https://atsumaru.github.io/api-references/screenshot
displayModal
このメソッドを呼び出した時点でのスクリーンショットを撮影し、Twitterに投稿するモーダルを表示します
setTweetMessage : ツイート内容差し替えAPI
スクリーンショットAPIやカメラボタンでモーダルを表示したときに、最初に表示されているツイート内容を差し替えます
※このエクステンションではパラメーター部分を２つまで
----------------------------------------------------------------------
□スコアボード・ランキング情報の取得（データとしての取得）
https://atsumaru.github.io/api-references/scoreboard/api
getRecords
指定したボードＩＤのランキング情報を内部に格納します(２項式より取り出せます)
----------------------------------------------------------------------
□グローバルサーバー変数
https://atsumaru.github.io/api-references/global-server-variable
*前もってトリガーの設定が必要です
getGlobalServerVariable
指定したＩＤのGlobalServerVariable情報を内部に格納します(２項式より取り出せます)
getGlobalServerVariableByName
指定した呼称のGlobalServerVariable情報を内部に格納します(２項式より取り出せます)
triggerCall - id
triggerCall - id & val
triggerCall - id & str
指定したＩＤのトリガーを起動させます
triggerCallByName - id
triggerCallByName - id & val
triggerCallByName - id & str
指定した呼称のトリガーを起動させます
※グローバルサーバー変数は直接書き換えることは出来ず、事前に登録してあるトリガーを使って操作する仕様になっています
----------------------------------------------------------------------
□プレイヤー間通信の有効化
interplayer_enable
プレイヤー間通信の有効化を行う
----------------------------------------------------------------------
□共有セーブ ※プレイヤー間通信の有効化が必要
https://atsumaru.github.io/api-references/shared-save
getSharedItemString
ユーザーＩＤと、ゲームＩＤから保管されている共有セーブ情報(文字列情報)を得ます(２項式より取り出せます)
ゲームＩＤ部分は0をセットすると、起動中のゲームが対象になります
setSharedSave
現在のゲームに共有セーブ情報を書き込みます(文字列)
removeSharedItem
指定したセーブデータを削除します
----------------------------------------------------------------------
□ユーザー情報にアクセスする *プレイヤー間通信の有効化が必要
https://atsumaru.github.io/api-references/user
getSelfInformation
自分自身の情報を内部に格納します(２項式より取り出せます)
getUserInformation
指定したユーザーの情報を内部に格納します(２項式より取り出せます)
----------------------------------------
□最近プレイしたユーザー情報を得る
getRecentUsers
現在のゲームを最近プレイしたユーザーの情報を内部に格納します(２項式より取り出せます)
getActiveUserCount
何分前までの間にオンラインだったユーザーの数を返します(２項式より取り出せます)
1〜60までの数値を指定し、今から分前までの間にこのゲームをプレイしたログインユーザーの人数を取得します。
----------------------------------------------------------------------
□シグナルを送信する *プレイヤー間通信の有効化が必要
https://atsumaru.github.io/api-references/signal
sendSignalToGlobal
ゲームのグローバルシグナルとして data で指定した文字列を送信します。
シグナルとして、任意の文字列を100byte以内で送信できます
getGlobalSignals
グローバルシグナルの情報を内部に格納します(２項式より取り出せます)
sendSignalToUser
指定したＩＤのユーザーにシグナルを送信します
getUserSignals
ユーザーのシグナル情報を内部に格納します(２項式より取り出せます)
----------------------------------------------------------------------
□ニコニ広告に関する取得
https://atsumaru.github.io/api-references/nicoad/
nicoad_getPoints(in EX Buffer)
ニコニ広告ポイントを取得します(２項式より取り出せます)
nicoad_getHistories(in EX Buffer)
ニコニ広告履歴を取得します(２項式より取り出せます)
nicoad_getRanking(in EX Buffer)
ニコニ広告貢献度ランキング取得(２項式より取り出せます)
----------------------------------------------------------------------
□バッファのクリア
clearRecordBuffer
clearGlobalServerVariableBuffer
clearSharedItemBuffer
clearSelfInformationBuffer
clearUserInformationBuffer
clearGlobalSignalBuffer
clearUserSignalBuffer
nicoad_clearGetPointsBuffer
nicoad_clearGetHistoriesBuffer
nicoad_clearGetRankingBuffer
内部に格納している情報を消去します。
（取り出したデータが不必要になった場合など、任意で消せます）
clear_ViewCommentBuffer
表示されたコメント取得用のデータをクリアします
================================================================================
================================================================================
■Expressions (２項式)
※以下はgetRecordsより内部に格納されたデータになります
record_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
myRecord - isNewRecord
スコアボードによる自身の記録情報を得ます 1であれば記録更新
myRecord - rank
自身のランキング順位を得ます
myRecord - score
自身のスコアを得ます
myBestRecord - userName
ベストレコードによる自身の名前を得ます
myBestRecord - rank
ベストレコードによるランキング順位を得ます
myBestRecord - score
ベストレコードによるスコアを得ます
myBestRecord - userId
ベストレコードによる自身のユーザーＩＤを得ます
ranking - count
取得したランキング数を得ます
ranking - userName
指定した要素数（配列番号）のユーザー名を得ます
ranking - rank
指定した要素数（配列番号）の順位を得ます
ranking - score
指定した要素数（配列番号）のスコアを得ます
ranking - userId
指定した要素数（配列番号）のユーザーＩＤを得ます
boardId
取得したスコアボードのＩＤを得ます
boardName
スコアボード名を得ます
----------------------------------------------------------------------
※以下は getGlobalServerVariable , getGlobalServerVariableByName より 内部に格納されたデータになります
global_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
globalServerVariable - name
取得したグローバルサーバー変数の名称を得ます
globalServerVariable - maxValue
取得したグローバルサーバー変数の最大値を得ます
globalServerVariable - minValue
取得したグローバルサーバー変数の最小値を得ます
globalServerVariable - value
取得したグローバルサーバー変数の現在値を得ます
----------------------------------------------------------------------
※以下は getSharedItemString より 内部に格納されたデータになります
shared_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
getSharedItemString
取得した共通データ（文字列）を取得します
----------------------------------------------------------------------
※以下は getSelfInformation より 内部に格納されたデータになります
self_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
getSelfInformation - id
ユーザーのニコニコユーザーID
getSelfInformation - name
ユーザーの名前
getSelfInformation - profile
ユーザーのプロフィール文
getSelfInformation - twitterId
ユーザーのtwitterId
getSelfInformation - url
ユーザーのサイトURL
getSelfInformation - isPremium
ユーザーがニコニコのプレミアム会員かどうか ( 0 or 1 )
----------------------------------------------------------------------
※以下は getUserInformation より 内部に格納されたデータになります
user_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
getUserInformation - id
ユーザーのニコニコユーザーID
getUserInformation - name
ユーザーの名前
getUserInformation - profile
ユーザーのプロフィール文
getUserInformation - twitterId
ユーザーのtwitterId
getUserInformation - url
ユーザーのサイトURL
----------------------------------------------------------------------
※以下は getRecentUsers より 内部に格納されたデータになります
resent_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
getRecentUserCount
格納されている件数
getRecentUsers - id
ユーザーのニコニコユーザーID
getRecentUsers - name
ユーザーの名前
------------------------------
※以下は getActiveUserCount より 内部に格納されたデータになります
active_user_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
getActiveUserCount
何分前までの間にオンラインだったユーザーの数を返します
----------------------------------------------------------------------
※以下は getGlobalSignals より 内部に格納されたデータになります
global_signal_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
getGlobalSignalCount
格納されている件数
getGlobalSignalData - timestamp
シグナルが送信された日時(秒単位のunix timestamp)
getGlobalSignalData - data
送信された文字列
getGlobalSignalData - id
シグナルそれぞれでユニークなID値
getGlobalSignalData - senderId
シグナルを送信したユーザーのニコニコユーザーID
getGlobalSignalData - senderName
シグナルを送信したユーザーのユーザー名
----------------------------------------------------------------------
※以下は getUserSignals より 内部に格納されたデータになります
user_signal_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
getUserSignalCount
格納されている件数
getUserSignalData - id
シグナルそれぞれでユニークなID値
getUserSignalData - senderId
シグナルを送信したユーザーのニコニコユーザーID
getUserSignalData - senderName
シグナルを送信したユーザーのユーザー名
getUserSignalData - data
送信された文字列
getUserSignalData - timestamp
シグナルが送信された日時(秒単位のunix timestamp)
----------------------------------------------------------------------
※以下は nicoad_getPoints より 内部に格納されたデータになります
getPoints_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
getPoints_activePoint
アクティブポイント：広告期間以内の広告の合計ポイント
getPoints_totalPoint
トータルポイント：広告期間が終了したものも含めたすべての広告の合計ポイント
---------------------------
※以下は nicoad_getHistories より 内部に格納されたデータになります
getHistories_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
getHistories_remainingCount
今回取得した広告履歴の他に、あと何件広告されたか
getHistories_serverTime
サーバー時刻
getHistories_LoadCount
格納されている件数
getHistories_advertiserName
広告の広告者名
getHistories_nicoadId
広告の広告ID
getHistories_adPoint
広告のポイント
getHistories_contribution
広告の貢献度
getHistories_startedAt
広告の掲載開始時間
getHistories_endedAt
広告の掲載終了時間
---------------------------
※以下は nicoad_getRanking より 内部に格納されたデータになります
getRanking_load_status
データの取得状況を表します 0:未動作 1:通信中 2:取得完了 -1:取得失敗
getRanking_LoadCount
格納されている件数
getRanking_advertiserName
ランキングの広告者名
getRanking_totalContribution
ランキングの貢献度
getRanking_rank
ランキングの順位
---------------------------
投稿された・したコメントの取得
getViewComment_Count
表示されたコメントの数
getViewComment_Command(num)
表示されたコメントのコマンド文字列を得る
getViewComment_String(num)
表示されたコメント文字列を得る
getInputComment_Command
投稿されたコメントのコマンド文字列を得る
getInputComment_String
投稿されたコメント文字列を得る
----------------------------------------------------------------------
■実験＆サンプル
コメント文字列取得サンプル ViewCommentSample.mfa
https://game.nicovideo.jp/atsumaru/games/gm12228?key=9c8f699a3b5a
スクリーンショット機能 screen_shot.mfa
https://game.nicovideo.jp/atsumaru/games/gm11516?key=ee550faf75b4
ニコニ広告情報を取得するサンプル nicoAD_Sample.mfa
https://game.nicovideo.jp/atsumaru/games/gm11660?key=8df72f521798
最近プレイしたユーザー情報を得る RecentUsers.mfa
https://game.nicovideo.jp/atsumaru/games/gm11527?key=f098b52d2146
シグナルを送信するサンプル Signal.mfa
https://game.nicovideo.jp/atsumaru/games/gm11526?key=00e5acc07dd8
ユーザー情報にアクセスするサンプル UserInformation.mfa
https://game.nicovideo.jp/atsumaru/games/gm11524?key=3764478d9f26
共有セーブのサンプル SharedItemString.mfa
https://game.nicovideo.jp/atsumaru/games/gm11522?key=c36269d1e5f6
グローバルサーバー変数のサンプル Global_values.mfa
https://game.nicovideo.jp/atsumaru/games/gm11521?key=fbe5c89096ce
スコアボード情報管理 Score_board_data.mfa
https://game.nicovideo.jp/atsumaru/games/gm11517?key=68982c31537f
作者情報を表示するサンプル CreatorInformation.mfa
https://game.nicovideo.jp/atsumaru/games/gm11515?key=cce4f098cf63
スコアボード動作サンプル ScoreSample.mfa
https://game.nicovideo.jp/atsumaru/games/gm11444?key=b4a525129553
コメント管理動作サンプル CommentSample.mfa
https://game.nicovideo.jp/atsumaru/games/gm11461?key=2e9c8e36fedc
----------------------------------------------------------------------
■RPGアツマールAPI本家解説
https://github.com/atsumaru/api-references/blob/master/content/collections/apis/comment.md
----------------------------------------------------------------------