Timer (타이머) Widget Control
Timerウィジェットをスクリプトから制御するときに使用するWidget Control（Property · Method · Event）の一覧です。ウィジェットの紹介と使い方はTimerドキュメントを参照してください。
備考
以下の例のtimerIDは、キャンバスでTimerウィジェットに指定した名前（ID）です。スクリプトではwidgetID.memberの形式でアクセスします。
Widget Control一覧
| Widget Control | 種類 | シグネチャ | 説明 |
|---|---|---|---|
start | Method | start() | タイマーを開始値から開始 |
stop | Method | stop() | タイマーを停止（表示値は維持） |
reset | Method | reset() | タイマーを停止し、開始値に戻す |
isRunning | Method | isRunning(): boolean | 実行中であればtrueを返す |
onExpired | Event | onExpired = () => { ... } | カウントダウンが00:00に達したときに実行 |
Property
備考
該当なし — Timerウィジェットにはスクリプト専用のPropertyがありません。スクリプトからは、下記の共通Widget Control（getProperty / setProperty）で値を読み書きします。
Method
start
タイマーを開始値から開始します。カウントダウンモードは設定した時間から、カウントアップモードは0から開始します。実行中に再度呼び出すと、先に初期化してから再開します。編集（デザイン）モードでは動作しません。
- 種類: Method
- Parameters: なし
- Returns: なし
Example
timerID.start();
stop
タイマーを停止します。現在表示されている値はそのまま維持されます。
- 種類: Method
- Parameters: なし
- Returns: なし
Example
timerID.stop();
reset
タイマーを停止し、表示値を開始値に戻します。カウントダウンモードは設定した時間に、カウントアップモードは0に戻ります。
- 種類: Method
- Parameters: なし
- Returns: なし
Example
timerID.reset();
isRunning
タイマーが実行中かどうかを返します。
- 種類: Method
- Parameters: なし
- Returns:
boolean- 実行中であればtrue、停止状態であればfalse
Example
const running = timerID.isRunning();
Event
onExpired
カウントダウンタイマーが00:00に達したときに実行されます。実行する動作はコールバック関数で指定します。カウントアップモードでは発生しません。
- 種類: Event
- ハンドラー: 引数なしのコールバック関数
- Returns: なし
Example
timerID.onExpired = () => {
// 期限切れ時に実行するコード
};
共通Widget Control（すべてのウィジェット）
注記
すべてのウィジェットは、setProperty / getProperty / setStylePropertyのような名前ベースの共通Widget Control（Method）を使用できます。共通リファレンスドキュメント（作成予定）を参照してください。