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 - bindableEvent로 사용하는 것을 선호하는 경우 Connect() 및 Wait() 를 지원하는 RBXScriptSignal 유사 인터페이스.
• SubscribedConnections - 현재 이벤트를 듣고있는 모든 연결이 포함 된 ObjectEventConnection 배열.

ObjectEventConnection API

• Disconnect() - 이벤트에서 분리됩니다
• Reconnect() - 연결이 끊어집니다
• IsConnected() - 연결이 이벤트를 듣는 경우 true 를 반환합니다 false
• Event -이 연결과 관련된 ObjectEvent 됩니다
• Listener -이 연결과 관련된 기능

현재 기능 :

• 표준 roblox 이벤트 기능 세트 :
• • 이벤트에 연결;
• • 연결 분리;
• • 이벤트가 발사 될 때까지 실을 산출합니다.
• • 기능을 통해 인수를 전달;
• 맞춤 기능 :
• • 새로운 연결을 다시 연결하지 않고 연결이 끊어진 연결 (연결 재사용 기능)을 다시 연결합니다.
• • 주어진 이벤트에 대한 모든 활성 연결을 읽습니다.

목표 :

• 내부의 추상화;
• Roblox-like 구문은 TypeScript 구문에 대한 최소한의 품위를 유지하면서;
• OOP 구현에 대한 코드 가독성.
• 추가 (유용한) 기능으로 Roblox의 구현을 보완합니다.