roblox object event

@rbxts/object-event

這個針對Roblox-TS的NPM軟件包允許開發人員在無需訴諸BindableEvents情況下實現自定義事件。

這對於嚴重依賴庫和其他遊戲組件的OOP範式的項目特別有用。

該模塊可以在純LUA（U）腳本（通過ROJO或任何其他方式）或Roblox-Ts中使用（包括編譯時類型檢查）。

例子

 /////// Module.ts ///////

import ObjectEvent from "@rbxts/object-event"

const event = new ObjectEvent < [ number , String , Vector3 ] > ( )

event . Connect ( ( id , msg , position ) => {
    // We can safely assume that:
    // id is a number
    // msg is a string
    // position is a Vector3
} )

export event


/////// Waiter.server.ts ///////

import { event } from "./Module"

event . Fire ( 10 , "oof" , new Vector3 ( 1 , 2 , 3 ) )  // all good
event . Fire ( 10 , "oof" )                        // will not compile!

export { }

允許任何數字的各種參數：

 let event = new ObjectEvent < [ ... unknown ] > ( ) 

ObjectEvent API

• Connect(f) - f是一個將相應鍵入的參數並返回void函數。返回ObjectEventConnection
• Wait() - 產生線程直到事件發射為止。返回相應鍵入的值。
• Fire(...) - 開火。參數必須是事件的數字和類型。
• Event - RBXScriptSignal類似於Connect()和Wait()的接口，以防萬一您更喜歡將其用作bindableEvent。
• SubscribedConnections一個ObjectEventConnection s的數組，當前正在偵聽事件的所有連接。

ObjectEventConnection API

• Disconnect() - 與事件斷開連接
• Reconnect() - 恢復斷開連接
• IsConnected() - 如果連接正在收聽事件（這不是disconnect（）'ed），則返回true ，否則為false 。
• Event - 與此連接關聯的ObjectEvent
• Listener - 與此連接關聯的功能

當前功能：

• 標準Roblox事件功能集：
• • 連接到活動；
• • 斷開連接；
• • 產生線程，直到射擊事件為止；
• • 通過函數傳遞論點；
• 自定義功能：
• • 重新連接斷開連接的連接而無需建立新連接（重複使用連接的能力）。
• • 讀取給定事件的所有主動連接。

目標：

• 從內部的抽象；
• Roblox樣語法，同時保持打字稿語法的最低符號；
• OOP實現的代碼可讀性。
• 補充Roblox的實現以及額外的（有用）功能。