kre - 吉里吉里のリファレンスをコンソールから引く

kre は、吉里吉里のリファレンス マニュアルをコンソールから引くための Ruby スクリプトです。

必要なもの

ダウンロード

履歴

2004/03/06 0.1.1
各クラスの最初のメソッドが引けなかったのを修正。
2004/01/28 0.1.0
公開。

ライセンス

このスクリプトは、パブリックドメイン扱いとします。

インストール

スクリプトの先頭にある Ruby のパスを、各自の環境に合わせて修正します。

吉里吉里の kirikiri2/kr2doc/contents/ の下にあるリファレンスマニュアル を HDD にコピーし、kre スクリプトの先頭にある KIRIKIRI_DOCS_DIR が、 そのディレクトリを指すようにします。

使用例

引数なしで起動すると、クラス一覧を表示する。

% kre
AsyncTrigger
CDDASoundBuffer
Console
Controller
Debug
Font
Layer
MenuItem
MIDISoundBuffer
Plugins
Scripts
Storages
System
Timer
VideoOverlay
WaveSoundBuffer
Window
%

クラス名とメソッド名を引数に与えて検索する。

% kre System osName
System.osName

機能/意味
    OS 名
タイプ
    Systemクラスのプロパティ (読み出し専用)
説明
    　吉里吉里が動作している OS の名前を表します。

メソッド名だけでも検索できる。

% kre osName
System.osName

機能/意味
    OS 名
タイプ
    Systemクラスのプロパティ (読み出し専用)
説明
    　吉里吉里が動作している OS の名前を表します。

小文字でも、また途中まででも OK。

% kre win up
Window.update

機能/意味
    ウィンドウ内容の強制的な描画
タイプ
    Windowクラスのメソッド
...(略)

候補が複数あるときは、候補の一覧が表示される。

% kre top
Layer.top
VideoOverlay.top
Window.top

大文字による省略表記が使える。

% kre mIBFW
Layer.mainImageBufferForWrite

機能/意味
    メイン画像バッファポインタ(書き込み用)
タイプ
...(略)

Reference