組み込み関数 - システム
情報
Vket Cloudの基盤システム(ブラウザやOS)へのアクセスを実現する関数です。
システム
hsSystemOutput
void hsSystemOutput(string text)
引数で指定した文字列をコンソールに出力する。
hsSystemWriteLine
void hsSystemWriteLine(string text)
引数で指定した文字列をコンソールに出力し、最後に改行を出力する。
caution
現バージョンにおいて、文字列にアポストロフィ / シングルクォート( ' ' , U+0027)を含めると動作が停止するエラーが確認されております。
恐れ入りますが、文字列では同記号の使用を避けるようお願い致します。
hsSystemIsDebugMode
bool hsSystemIsDebugMode()
Vket Cloudがデバッグモードで動作している場合は true を返す。
hsIsMobile
bool hsIsMobile()
アプリがモバイルデバイスで実行されている場合は true を返す。
hsGetSDKVersion
string hsGetSDKVersion()
VketCloudSDKの現在のバージョン文字列を返す。
hsSystemGetTime
int hsSystemGetTime()
アプリが起動してからの経過時間をミリ秒単位で返す。
hsSystemGetDeltaTime
float hsSystemGetDeltaTime()
最後のフレームから、現在のフレームまでの経過時間を秒単位で返す。
hsGetDate
void hsGetDate(ref int year, ref int month, ref int day, ref int week, ref int hour, ref int minite, ref int second)
現在のローカルの日時を取得します。
年(year), 月(month), day(day) は、1から始まります。
週(week) は、{ 0=日, 1=月, ..., 6=土 } と続きます。
hsGetDateLocal
void hsGetDateLocal(ref int year, ref int month, ref int day, ref int week, ref int hour, ref int minite, ref int second)
現在のローカルの日時を取得します。
それぞれの数値の意味は、 hsGetDate() を確認してください。
hsGetDateUTC
void hsGetDateUTC(ref int year, ref int month, ref int day, ref int week, ref int hour, ref int minite, ref int second)
現在の日時をUTCで取得します。
それぞれの数値の意味は、hsGetDate() を確認してください。
hsGetEpochSeconds
int GetEpochSeconds()
UNIXエポック (UTCにおける1970年1月1日午前0時0分0秒) からの経過秒数を返します。
hsGetTimezoneOffset
int hsGetTimezoneOffset()
システム上の現在のタイムゾーンと、UTCタイムゾーンの差を分単位で返します。
hsGetCurrentWorldId
string hsGetCurrentWorldId()
ワールドIDを取得する。
hsGetWindowSize
void hsGetWindowSize(ref int width, ref int height)
ウィンドウのサイズをピクセル単位で取得します。
基本型の変換 (キャスト)
int(float)
int int(float)
浮動小数点数を整数値に変換します。
float(int)
float float(int)
整数値を浮動小数点数値に変換します。
bool(int)
bool bool(int)
整数値を真偽値に変換します。
0 は true、それ以外の値は false に変換されます。
string(int)
string string(int)
整数値を文字列に変換します。
string(float)
string string(float)
浮動小数点数値を文字列に変換します。
Web
hsWebOpen
void hsWebOpen(string url)
urlを開く。
hsWebReload
void hsWebReload()
Webページをリロードします。
言語
hsGetLang
string hsGetLang()
現在のシステムの言語を返します。(JavaScriptのnavigator.languageの値に相当する文字列を返します)
hsIsLangJA
bool hsIsLangJA()
現在のシステムの言語が日本語の場合にtrueを返します。
hsIsLangEN
bool hsIsLangEN()
現在のシステムの言語が英語の場合にtrueを返します。
トースト通知
hsSendToastNotice
void hsSendToastNotice(int noticeTypeID, string message, float viewTime, string identifyKey = "", string optionData = "")
画面右端から登場アニメーション付きでメッセージを通知します。
最大表示件数は5件で、6件以上は内部で保持し表示枠に空きが出来たら表示されます。
また、エラー通知以外はクリックをすると残り表示秒数に関係なく消すことが可能です。
トースト通知の状態が変化した場合にLocalイベントOnReceiveLocalData(string key, string data)が発火します。
string keyは固定で"toast"の文字列、string dataにトースト通知の情報がJsVal形式の文字列で入っています。
noticeTypeID (int)
通知するメッセージ種類のID。 IDとアイコンの対応は以下の通り。 |ID|TYPE| |---|---| |00|INFO| |10|WARNING| |20|ERROR| |nn|INFO (規定外はすべてINFOにされます)|
message (string)
トースト通知に表示するメッセージ文章を入力できます。
viewTime (float)
通知が画面で表示される時間を設定できます。
1 = 1秒で、登場/退場アニメーション時間はこの秒数に含まれません。（それぞれ0.5秒）
identifyKey (string)
ユーザーが任意に埋め込める識別キー。
"gimmickNoticeA:Interact_01"など。
optionData (string)
ユーザーが任意でトースト通知に埋め込めるデータ
トースト通知がクリックされた/時間超過で消えた時に発火されるLocalイベントOnReceiveLocalData(string key, string data)で受け取る事ができます。
string keyは固定で"toast"の文字列が入っています。
string dataにトースト通知の情報がJsVal形式の文字列で入っています。
※JsValはJsonデータをHeliScript内で取り扱う為のデータ形式。
● dataに格納されている情報
``json
{
"noticeTypeID" : "通知種類のID",
"identifyKey" : "ユーザーがidentifyKeyで決めた識別用文字列",
"message": "通知で表示していたメッセージ",
"sendAction": "このデータが送信されたタイミング",
"optionData": "ユーザーがoptionData`で入力したデータ"
}