API UO GetScriptName zh tw - LIHACHTETAN/ClassicUO-BadNewbie-BasicIDE GitHub Wiki
UO.GetScriptName
ClassicUO • Runtime API
讀取某個有效執行的顯示名稱。
完整語法
UO.GetScriptName(ScriptIndex:Any) -> String
參數
ScriptIndex— 必填 ScriptIndex:從最新 GetScriptsList 取得、由零開始的整數索引。負值或不存在的索引會傳回上述空值/未知狀態。不可傳入物品 serial、程序名稱或 IDE 執行 ID。
傳回值
String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
行為
- 包含執行中及暫停中的執行;排除已結束或已要求取消者。呼叫者通常也計算在內。僅載入 IDE 分頁不代表已執行。
- 索引是依啟動順序排列的目前位置。啟動/停止會使位置改變。多次呼叫不是同一個不可分割快照;之後下控制指令前應重新讀取清單。
- 關閉 Basic IDE 不會移除有效執行。這些指令僅查詢此客戶端,不涉及其他客戶端或 Windows 處理程序。
- GetScriptsList 提供索引,GetScriptsCount 提供數量,GetScriptState 提供三態狀態碼。不要混用,也不要把所有非零值視為 true。
- ScriptIndex=0 指目前第一個執行,不一定是呼叫者。SetScriptName 只變更顯示名稱,不會重新命名檔案。
內部函式:從呼叫到結果
以下列出客戶端的實際方法。Basic 範例包含完整輔助函式;內部 C# 方法名稱不是額外的腳本指令。
1. ExecuteStealthCompatibility
Runtime 呼叫已註冊的 UO 指令,將橋接結果包裝為 Integer、String 或 Array。
String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
專案原始碼: external/InjectionScript/src/InjectionScript/Runtime/InjectionApiUO.cs; 函式 ExecuteStealthCompatibility.
2. GetScriptName
橋接層使用此客戶端的執行管理器。
ScriptIndex=0 指目前第一個執行,不一定是呼叫者。SetScriptName 只變更顯示名稱,不會重新命名檔案。
專案原始碼: src/ClassicUO.Client/Game/Managers/ClassicUOInjectionApiBridge.cs; 函式 GetScriptName.
3. GetScriptName
ElementAt(RunningScripts(), index)?.Name ?? string.Empty
索引是依啟動順序排列的目前位置。啟動/停止會使位置改變。多次呼叫不是同一個不可分割快照;之後下控制指令前應重新讀取清單。
專案原始碼: src/ClassicUO.Client/Game/Managers/YokoInjectionManager.cs; 函式 GetScriptName.
關閉 Basic IDE 不會移除有效執行。這些指令僅查詢此客戶端,不涉及其他客戶端或 Windows 處理程序。
範例
第一次呼叫與結果
# 第一次呼叫與結果
#
# 讀取某個有效執行的顯示名稱。
#
# String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
SUB Main()
# 執行 Sub Main。傳入的 0 是索引;空括號代表沒有參數。Print 文字只是範例訊息。
# ScriptIndex=0 指目前第一個執行,不一定是呼叫者。SetScriptName 只變更顯示名稱,不會重新命名檔案。
# String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
# 必填 ScriptIndex:從最新 GetScriptsList 取得、由零開始的整數索引。負值或不存在的索引會傳回上述空值/未知狀態。不可傳入物品 serial、程序名稱或 IDE
# 執行 ID。
Dim index=0
Dim name=UO.GetScriptName(index)
UO.Print(name)
END SUB
參數與執行說明:
- 執行 Sub Main。傳入的 0 是索引;空括號代表沒有參數。Print 文字只是範例訊息。
- ScriptIndex=0 指目前第一個執行,不一定是呼叫者。SetScriptName 只變更顯示名稱,不會重新命名檔案。
- String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
- 必填 ScriptIndex:從最新 GetScriptsList 取得、由零開始的整數索引。負值或不存在的索引會傳回上述空值/未知狀態。不可傳入物品 serial、程序名稱或 IDE 執行 ID。
在迴圈或條件中使用
# 在迴圈或條件中使用
#
# 讀取某個有效執行的顯示名稱。
#
# String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
SUB Main()
# 這是結合多個指令的獨立範例。陣列索引從零開始,存取前須檢查長度。範例若使用 Wait(250),會等待 250 毫秒。
# ScriptIndex=0 指目前第一個執行,不一定是呼叫者。SetScriptName 只變更顯示名稱,不會重新命名檔案。
# String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
# 必填 ScriptIndex:從最新 GetScriptsList 取得、由零開始的整數索引。負值或不存在的索引會傳回上述空值/未知狀態。不可傳入物品 serial、程序名稱或 IDE
# 執行 ID。
Dim indices=UO.GetScriptsList()
For Each index In indices
Dim name=UO.GetScriptName(index)
UO.Print(CStr(index) & " = " & name)
Next
END SUB
參數與執行說明:
- 這是結合多個指令的獨立範例。陣列索引從零開始,存取前須檢查長度。範例若使用 Wait(250),會等待 250 毫秒。
- ScriptIndex=0 指目前第一個執行,不一定是呼叫者。SetScriptName 只變更顯示名稱,不會重新命名檔案。
- String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
- 必填 ScriptIndex:從最新 GetScriptsList 取得、由零開始的整數索引。負值或不存在的索引會傳回上述空值/未知狀態。不可傳入物品 serial、程序名稱或 IDE 執行 ID。
完整輔助函式
# 完整輔助函式
#
# 讀取某個有效執行的顯示名稱。
#
# String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
SUB Main()
# Main 下方列出完整函式。其參數與結果應與內部呼叫的 API 指令分開理解。
# DescribeScript 檢查狀態後結合名稱與路徑。呼叫之間可能停止;"missing" 是輔助函式的值,不是 GetScriptName 的結果。
# String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
# 必填 ScriptIndex:從最新 GetScriptsList 取得、由零開始的整數索引。負值或不存在的索引會傳回上述空值/未知狀態。不可傳入物品 serial、程序名稱或 IDE
# 執行 ID。
UO.Print(DescribeScript(0))
END SUB
Function DescribeScript(index) As String
If UO.GetScriptState(index)=0 Then
Return "missing"
End If
Return UO.GetScriptName(index) & " | " & UO.GetScriptPath(index)
End Function
參數與執行說明:
- Main 下方列出完整函式。其參數與結果應與內部呼叫的 API 指令分開理解。
- DescribeScript 檢查狀態後結合名稱與路徑。呼叫之間可能停止;"missing" 是輔助函式的值,不是 GetScriptName 的結果。
- String:顯示名稱;找不到索引時為 ""。存在的執行也可以被明確設定為空名稱。
- 必填 ScriptIndex:從最新 GetScriptsList 取得、由零開始的整數索引。負值或不存在的索引會傳回上述空值/未知狀態。不可傳入物品 serial、程序名稱或 IDE 執行 ID。