PreloadJSのLoadQueue.fileprogressイベントで読込みパーセンテージを調べる

PreloadJSのLoadQueue.fileprogressイベントで読込みパーセンテージを調べる [Edit]

投稿者：野中文雄 | 投稿日：2013.05.05 | [CreateJS][バグ][野中ゼミ]

PreloadJSのLoadQueue.fileprogressイベントで読込まれたパーセンテージは、イベントオブジェクトから調べられます。ところが、ドキュメンテーションのプロパティ名が誤っています(図001)。

図001■ドキュメンテーションのLoadQueue.fileprogressイベントの項

「PreloadJS v0.3.0 API Documentation」のLoadQueue.fileprogressイベントの項には、イベントオブジェクトのプロパティ名がつぎのように「percent」と記されています。

fileprogress
Defined in fileprogress:355
Available since 0.3.0

This event is fired when an an individual file progress changes.
Event Payload:
...[中略]...

percent Number
The percentage that has been loaded. This will be a number between 0 and 1.

ところが、LoadQueue.fileprogressイベントを内部的に送るLoadQueue._sendFileProgressメソッドの実装を見ると、読込みパーセンテージは、プロパティ「progress」として加えられています。正しいプロパティ名はこちらで、現在開発が進むPreloadJSライブラリでは、関連するイベントも含めてコメントは修正されています(「Comment updates, including doc fix to progress "progress" properties.」参照)。

また、つぎのバージョンに向けて用意されているドキュメンテーション「PreloadJS vNEXT API Documentation」ではつぎのように訂正されています。このファイル(Zip圧縮)は、GitHubからダウンロードできます(図002)。

Event Payload:
...[中略]...

progress Number
The percentage that has been loaded. This will be a number between 0 and 1.

図002■GitHubのドキュメンテーションをダウンロードするページ
PreloadJS/docs at master

なお、ドキュメントに書かれているとおり、プロパティ値は読込みの"percentage"といいつつ、実は0から1までの小数値です。

F-site

PreloadJSのLoadQueue.fileprogressイベントで読込みパーセンテージを調べる [Edit]