実績 link
Achievement モジュールは開発者がプレイヤーに実績を授与したり、クリアしたり、実績が授与されたか判定出来るようにしたりします。実績への達成度の記録もできます。
デフォルトでは Achievement は persistent ファイルに情報を保存します。Steam のサポートが利用可能かつ有効なら実績情報は自動的に steam と同期します。
Steam サポートは Steam のパートナープログラムに同意した制作者によって配布されるのみであることを確認してから Ren'Py に追加される必要があります。インストールにはランチャーから "preferences", "Install libraries", "Install Steam Support" を選択してください。
- achievement.Sync() link
achievement.sync() を呼び出すアクションです。これは実績が同期されていないときのみ有効になります。
- achievement.clear(name) link
name 実績をクリアします。
- achievement.clear_all() link
すべての実績をクリアします。
- achievement.get_progress(name) link
name 実績への達成度を返します。その実績の進行が登録されていないまたは不明なら 0 です。
- achievement.grant(name) link
既に授与されていなければ、 name 実績を授与します。
- achievement.has(name) link
プレイヤーに name 実績が授与されていれば True を返します。
- achievement.progress(name, complete) link
name 実績がまだ授与されたことがなければ、(*訳注 complete までの達成を授与した上で)実績の達成度を報告します。その実績には達成度が定義されていなければなりません。
- name
実績の名前です。これは実績名で、 stat ではありません。
- complete
その実績達成へ向けて完了した行程数の整数値です。
- achievement.register(name, **kwargs) link
実績を登録します。実績が登録される必要はありませんが、こうするとバックエンドに情報を渡せます。
- name
登録する実績の名前です。
以下のキーワードパラメーターは任意です。
- steam
steam で使用する名前です。指定されないとデフォルトで name になります。
- stat_max
実績が開放される stat の整数値です。
- stat_modulo
達成度の stat_modulo による剰余が 0 なら達成度はユーザーに表示されます。例えば stat_modulo が 10 なら、達成度が 10, 20, 30… のときにユーザーに表示されます。指定されないと、これはデフォルトで 0 になります。
- achievement.sync() link
ローカルストレージとその他のバックエンド (steam など ) の登録された実績を同期します。
Achievement を制御する変数 :
- achievement.steam_position = None link
None またはSteamの通知ポップの位置設定です。これは "top left" または "top right", "bottom left", "bottom right" のいずれかの文字列でなければなりません。
- define config.steam_appid = None link
None または Steam appid です。 Ren'Py は開始時に自動的にこの appid を設定します。これは define ステートメントで設定される必要があります。
define config.steam_appid = 12345
- define config.automatic_steam_timeline = True link
True ならば、 Steam 下で起動されると自動的に steam タイムラインを更新します。
現在のところ次で構成されます :
save_name
変数が設定されていれば、状態の記述を合わせるよう更新します。プレイヤーがメニュー内にいれば、ゲームモードを更新します。
Steamworks API link
Steam が利用できるなら、 Steamworks API への ctypes ベースのバインディングが achievement.steamapi
として利用可能です。このバインディングは、 こちら にあるように steamapi モジュールのインスタンスであり、C++ Steamworks API の Python への機械翻訳を表しています。
加えて Steamworks API が利用可能な場合に限り、 achievement.steam オブジェクトで多数の関数を使用できます。
- achievement.steam link
Steam の初期化に成功していれば、これは高級なSteamメソッドの名前空間になります。Steam が初期化されていなければ、 None になります。呼び出し前に None でないことを常に確認してください。
Steam Apps link
- achievement.steam.dlc_installed(appid) link
dlc がインストールされている場合は True を返し、それ以外の場合は False を返します。
- achievement.steam.dlc_progress(appid) link
DLCのダウンロード完了に向けた進捗状況を報告します。
- achievement.steam.get_app_build_id() link
インストールされているゲームのビルド ID を返します。
- achievement.steam.get_current_beta_name() link
現在のベータ版の名前を返すか、返せない場合は None を返します。
- achievement.steam.get_current_game_language() link
ユーザーが選択した言語の名前を返します。
- achievement.steam.get_steam_ui_language() link
Steam UIが使用している言語の名前を返します。
- achievement.steam.install_dlc(appid) link
appid を持つ DLC のインストールを要求します。
- achievement.steam.is_subscribed_app(appid) link
ユーザーが appid のアプリを所有している場合は true を返し、それ以外の場合は false を返します。
- achievement.steam.uninstall_dlc(appid) link
appid を持つ DLC のアンインストールを要求します。
Steam Overlay link
- achievement.steam.activate_overlay(dialog) link
Steamオーバーレイをアクティブにします。
- dialog
オーバーレイを開くダイアログです。 "Friends", "Community", "Players", "Settings", "OfficialGameGroup", "Stats", "Achievements" のいずれかです。
- achievement.steam.activate_overlay_to_store(appid, flag=None) link
ストアへの steam オーバーレイを開きます。
- appid
開く appid
- flag
achievement.steam.STORE_NONE, STORE_ADD_TO_CART, .STORE_ADD_TO_CART_AND_SHOW のいずれかです
- achievement.steam.activate_overlay_to_web_page(url) link
Steamオーバーレイを有効にし、Webページを url で開きます。
- achievement.steam.is_overlay_enabled() link
Steamオーバーレイが有効な場合は true を返します (ゲームが開始されると、これが true に戻るまでに時間がかかる場合があります。
- achievement.steam.overlay_needs_present() link
Steamオーバーレイが有効な場合は true を返します (ゲームが開始されると、これが true に戻るまでに時間がかかる場合があります。
- achievement.steam.set_overlay_notification_position(position) link
steam オーバーレイの位置を設定します。 Position は achievement.steam.POSITION_TOP_LEFT, .POSITION_TOP_RIGHT, .POSITION_BOTTOM_LEFT, POSITION_BOTTOM_RIGHT のいずれか1つです。
Steam Stats link
- achievement.steam.clear_achievement(name) link
name の実績をクリアします。
_renpysteam.store_stats()
を呼び出して、この変更をサーバーにプッシュしてください。
- achievement.steam.get_achievement(name) link
name の実績の状態を取得します。その実績が付与されている場合は True、付与されていなければ False、その実績が不明な場合やエラーが発生した場合は None が返されます。
- achievement.steam.get_float_stat(name) link
name の stat の値を返すか、そのような stat が存在しない場合は None を返します。
- achievement.steam.get_int_stat(name) link
name の stat の値を返すか、そのような stat が存在しない場合は None を返します。
- achievement.steam.grant_achievement(name) link
name の実績を付与します。
_renpysteam.store_stats()
を呼び出して、この変更をサーバーにプッシュしてください。
- achievement.steam.indicate_achievement_progress(name, cur_progress, max_progress) link
実績の進行状況をユーザーに示します。これは、実績のロックを解除しません。
- achievement.steam.list_achievements() link
実績名のリストを返します。
- achievement.steam.retrieve_stats() link
Steamから実績と統計を取得します。
- achievement.steam.set_float_stat(name, value) link
name の stat の値を設定しますが、これは FLOAT 型でなければなりません。
_renpysteam.store_stats()
を呼び出して、この変更をサーバーにプッシュしてください。
- achievement.steam.set_int_stat(name, value) link
name の stat の値を設定しますが、これは INT 型でなければなりません。
_renpysteam.store_stats()
を呼び出して、この変更をサーバーにプッシュしてください。
- achievement.steam.store_stats() link
統計と実績を Steam サーバーに保存します。
Steam Timeline link
- achievement.steam.add_timeline_event(icon, title, description, priority=0, start_offset=0.0, duration=0.0, possible_clip=None) link
タイムラインにイベントを追加します。
- icon
イベントに表示するアイコンです。これは、標準の Steam アイコンまたはあなたが Steam にアップロードしたアイコンの文字列の1つである必要があります。
- title
登録するイベントの名前です。
- description
イベントの説明です。
- priority
競合の解決に使用されるイベントの優先度です。これは、 0 から 1000 までの整数である必要があります。
- start_offset
現在の時刻からイベントの開始までのオフセットです (秒単位)。
- duration
イベントの継続時間 (秒単位)。
- possible_clip
イベントをクリップできるかどうかを決めます。これは achievement.steam.CLIP_PRIORITY_XXX形式の定数: CLIP_PRIORITY_NONE、CLIP_PRIORITY_STANDARD、 CLIP_PRIORITY_FEATURED の1つであるべきです。
- achievement.steam.clear_timeline_state_description(time_delta) link
タイムラインの現在の状態の説明をクリアします。
- achievement.steam.set_timeline_state_description(description, time_delta=0.0) link
タイムラインの現在の状態の説明を設定します。
- description
現在の状態の説明を示す文字列。
- time_delta
最後の状態変更からの時間。
Steam User link
- achievement.steam.cancel_ticket() link
achievement.steam.get_session_ticket()
によって返されたチケットをキャンセルします。
- achievement.steam.get_account_id() link
ユーザーのアカウント ID を返します。
- achievement.steam.get_csteam_id() link
ユーザーの完全な CSteamID を64ビットの数値として返します。
- achievement.steam.get_game_badge_level(series, foil) link
ゲームのユーザーの Steam バッジのレベルを取得します。
- achievement.steam.get_persona_name() link
ユーザーのパブリックに表示される名前を返します。
- achievement.steam.get_session_ticket() link
このユーザーを認証するためにサーバーに送信できるチケットを取得します。
Steam Workshop link
- achievement.steam.get_subscribed_item_path(item_id) link
ユーザー生成コンテンツの項目がインストールされたパスを返します。項目がインストールされていない場合は None を返します。
- item_id
アイテム ID
- achievement.steam.get_subscribed_items() link
ユーザーが Steam ワークショップで購読しているアイテム ID のリストを返します。