API

acutil

acutil.addThousandsSeparator(number)

parameter

• number number : 数値

return

• string : 数値を3桁毎にカンマ区切りした文字列

description

• 引数の数値を3桁毎にカンマ区切りした文字列を返す

acutil.tostring(var)

parameter

• number bool var : 文字列する値

return

• string : 引数を文字列に変換したもの

description

• 引数を文字列にして返す
• bool型のtrueやfalse,nilなどを文字列に変換する時に使用する

acutil.getStatPropertyFromPC(typeStr, statStr, pc)

description

• プレイヤーのステータスを返す
• ジョブ基礎値や振った値、ボーナスなどを取得できる

acutil.getItemRarityColor(itemObj)

parameter

• object itemObj : itemのIES Object

return

• string : カラーコード(FFFFFFなど)

description

• アイテムのIESObjectを与えるとレアリティに応じたカラーコードを返えす

acutil.setupHook(newFunction, hookedFunctionStr)

parameter

• function newFunction : 自分が新しく作成した関数
• string hookedFunctionStr : 置き換える関数名

description

• すでに存在する関数に自作の関数などを上書きする

• 元の関数は_G['HOGE_OLD']のように_OLDを加え保存される

• 下記のものと同じ

HOGE_HOOK = function()end
_G['HOGE_OLD'] = _G['HOGE']
_G['HOGE'] = HOGE_HOOK

setupEvent(myAddon, functionNameAbs, myFunctionName)

parameter

• string myAddon : ON_INITなどの引数にあるアドオン
• string functionNameAbs : 紐付けられる関数名
• string myFunctionName : 紐付ける関数名

description

• 自作の関数を既存の関数が呼び出された時に、同時に呼び出すように紐付ける

acutil.saveJSON(path, tbl)

• null

acutil.loadJSON(path, tblMerge, ignoreError)

• null

acutil.slashCommand(cmd, fn)

parameter

• string cmd : 登録するコマンド
• function fn : 実行される関数

return

• (none)

description

• /コマンドを登録する,cmdには'/dev'のように書く

---

cwAPI

• 使用するにはjson.luaが必要

cwAPI.util.log(msg)

parameter

• string msg: チャット欄に出力したい文字列

return

• (none)

description

• CHAT_SYSTEMのラッパー関数
• CHAT_SYSTEMと使い方は同じだが、CHAT_SYSTEMより多少安全
• 以下のように使うと楽

local log = cwAPI.util.log;

...

log("debug message.");

cwAPI.json.load(folder, filename, ignoreError)

parameter

• string folder : 対象フォルダ名
• string filename : 対象ファイル名(拡張子除く)
  • nilの場合folderと同じ文字列が使用される
• boolean ignoreError : エラー無視フラグ
  • falseを指定するとファイル操作失敗時にエラーメッセージを画面に表示する
  • 通常はtrueで問題ないと思うよ

return

• table: json形式文字列をtable型に変換したもの

description

• 指定されたjsonファイルをロードする
• 戻り値に対するエラーチェック機構はあった方がいいかも

cwAPI.json.save(object, folder, filename, simple)

parameter

• table object : jsonに保存したい情報
• string folder : 対象フォルダ名
• string filename : 対象ファイル名(拡張子除く)
  • nilの場合folderと同じ文字列が使用される
• ??? simple: (未使用)

return

• json形式文字列

description

• objectの中身をjsonファイルに上書き保存する
• jsonファイルが存在しない場合は作成してくれる
  • ディレクトリは作成してくれないので注意
• 戻り値は普段は使わない