@babylonjs/core
Version:
Getting started? Play directly with the Babylon.js API using our [playground](https://playground.babylonjs.com/). It also contains a lot of samples to learn how to use it.
46 lines (45 loc) • 1.55 kB
TypeScript
import type { RichType } from "../../flowGraphRichTypes.js";
import { FlowGraphExecutionBlockWithOutSignal } from "../../flowGraphExecutionBlockWithOutSignal.js";
import type { FlowGraphContext } from "../../flowGraphContext.js";
import type { IFlowGraphBlockConfiguration } from "../../flowGraphBlock.js";
/**
* Parameters used to create a FlowGraphSendCustomEventBlock.
*/
export interface IFlowGraphSendCustomEventBlockConfiguration extends IFlowGraphBlockConfiguration {
/**
* The id of the event to send.
* Note - in the glTF specs this is an index to the event array (i.e. - a number)
*/
eventId: string;
/**
* The names of the data inputs for that event.
*/
eventData: {
[key: string]: {
type: RichType<any>;
value?: any;
};
};
}
/**
* A block that sends a custom event.
* To receive this event you need to use the ReceiveCustomEvent block.
* This block has no output, but does have inputs based on the eventData from the configuration.
* @see FlowGraphReceiveCustomEventBlock
*/
export declare class FlowGraphSendCustomEventBlock extends FlowGraphExecutionBlockWithOutSignal {
/**
* the configuration of the block
*/
config: IFlowGraphSendCustomEventBlockConfiguration;
constructor(
/**
* the configuration of the block
*/
config: IFlowGraphSendCustomEventBlockConfiguration);
_execute(context: FlowGraphContext): void;
/**
* @returns class name of the block.
*/
getClassName(): string;
}