Module content.gui.main.tool_react_util🔗
global record ToolReactUtil
registerToolWithWindow: function<TP is IToolParam, WPisIToolWindowParam<TP>>(string, string, Recipe<WP>, function(TP) : string): ReactToolDefinition<TP> registerVariantToolWithWindow: function<TP is IToolParam, WPisIToolWindowParam<TP>>(string, string, Recipe<WP>, function(TP) : string, function(TP) : string): ReactToolDefinition<TP> registerVariantToolWithPersistentWindows: function<TP is IToolParam, WPisIToolWindowParam<TP>>(string, function(TP) : string, Recipe<WP>, function(TP) : string, function(TP) : string): ReactToolDefinition<TP> prepareDefaultToolWithWindowDefinition: function<TP is ToolReactUtil.IToolParam, WPisToolReactUtil.IToolWindowParam<TP>>(string, string, Recipe<WP>, function(TP) : string, function(TP) : string, function(TP) : string): ReactToolDefinition<TP>interface ToolWindowParamPayload<TP is IToolParam>
toolParam: TP setActionFn: function(function() : TreeNodeId, string) setVariantOverride: function(string) endinterface DelegatingToolDefinition<PublicParam, InternalParam>
delegate: ReactToolDefinition<InternalParam> endregisterDelegatingTool: function<PublicParam, InternalParam>(ReactToolDefinition<InternalParam>): DelegatingToolDefinition<PublicParam, InternalParam> firePushToolEvent: function<TP, DP>(PushToolEventParam<TP, DP>) firePopToolEvent: function<TP, DP>(PopToolEventParam<TP, DP>) onPushToolEvent: function<TP, DP>(DelegatingToolDefinition<TP, DP>, function(ToolReactUtil.PushToolEventParam<TP, DP>)) onPopToolEvent: function<TP, DP>(DelegatingToolDefinition<TP, DP>, function(ToolReactUtil.PopToolEventParam<TP, DP>)) endrecord PushToolEventParam<TP, DP>
tool: DelegatingToolDefinition<TP, DP> key: string param: TP allowStacking: boolean end
Category: globals🔗
ToolReactUtil🔗
global record ToolReactUtil
registerToolWithWindow: function<TP is IToolParam, WPisIToolWindowParam<TP>>(string, string, Recipe<WP>, function(TP) : string): ReactToolDefinition<TP> registerVariantToolWithWindow: function<TP is IToolParam, WPisIToolWindowParam<TP>>(string, string, Recipe<WP>, function(TP) : string, function(TP) : string): ReactToolDefinition<TP> registerVariantToolWithPersistentWindows: function<TP is IToolParam, WPisIToolWindowParam<TP>>(string, function(TP) : string, Recipe<WP>, function(TP) : string, function(TP) : string): ReactToolDefinition<TP> prepareDefaultToolWithWindowDefinition: function<TP is ToolReactUtil.IToolParam, WPisToolReactUtil.IToolWindowParam<TP>>(string, string, Recipe<WP>, function(TP) : string, function(TP) : string, function(TP) : string): ReactToolDefinition<TP>interface ToolWindowParamPayload<TP is IToolParam>
toolParam: TP setActionFn: function(function() : TreeNodeId, string) setVariantOverride: function(string) endinterface DelegatingToolDefinition<PublicParam, InternalParam>
delegate: ReactToolDefinition<InternalParam> endregisterDelegatingTool: function<PublicParam, InternalParam>(ReactToolDefinition<InternalParam>): DelegatingToolDefinition<PublicParam, InternalParam> firePushToolEvent: function<TP, DP>(PushToolEventParam<TP, DP>) firePopToolEvent: function<TP, DP>(PopToolEventParam<TP, DP>) onPushToolEvent: function<TP, DP>(DelegatingToolDefinition<TP, DP>, function(ToolReactUtil.PushToolEventParam<TP, DP>)) onPopToolEvent: function<TP, DP>(DelegatingToolDefinition<TP, DP>, function(ToolReactUtil.PopToolEventParam<TP, DP>)) endrecord PushToolEventParam<TP, DP>
tool: DelegatingToolDefinition<TP, DP> key: string param: TP allowStacking: boolean end
ToolReactUtil.IToolParam🔗
ToolReactUtil.IToolParam.gameCtx🔗
ToolReactUtil.IToolParam.gameCtx: GameContext
ToolReactUtil.ToolWindowParamPayload🔗
interface ToolReactUtil.ToolWindowParamPayload<TP is IToolParam>
toolParam: TP setActionFn: function(function() : TreeNodeId, string) setVariantOverride: function(string) end
Type Parameters
TP( isIToolParam)
ToolReactUtil.ToolWindowParamPayload.toolParam🔗
ToolReactUtil.ToolWindowParamPayload.toolParam: TP
ToolReactUtil.ToolWindowParamPayload.setActionFn🔗
function ToolReactUtil.ToolWindowParamPayload.setActionFn(function() : TreeNodeId, string)Parameters
function(): TreeNodeIdstring
ToolReactUtil.ToolWindowParamPayload.setVariantOverride🔗
function ToolReactUtil.ToolWindowParamPayload.setVariantOverride(string)Parameters
string
ToolReactUtil.IToolWindowParam🔗
interface ToolReactUtil.IToolWindowParam<TP>
onClose: function() payload: ToolWindowParamPayload<TP> end
Type Parameters
TP
ToolReactUtil.IToolWindowParam.onClose🔗
function ToolReactUtil.IToolWindowParam.onClose()
ToolReactUtil.IToolWindowParam.payload🔗
ToolReactUtil.IToolWindowParam.payload: ToolWindowParamPayload<TP>
ToolReactUtil.registerToolWithWindow🔗
function ToolReactUtil.registerToolWithWindow<TP is IToolParam, WPisIToolWindowParam<TP>>(string, string, Recipe<WP>, function(TP) : string): ReactToolDefinition<TP>
Type Parameters
TP( isIToolParam)WP( isIToolWindowParam<TP>)
stringstringRecipe<WP>function(TP): string
ReactToolDefinition<TP>
ToolReactUtil.registerVariantToolWithWindow🔗
function ToolReactUtil.registerVariantToolWithWindow<TP is IToolParam, WPisIToolWindowParam<TP>>(string, string, Recipe<WP>, function(TP) : string, function(TP) : string): ReactToolDefinition<TP>
Type Parameters
TP( isIToolParam)WP( isIToolWindowParam<TP>)
stringstringRecipe<WP>function(TP): stringfunction(TP): string
ReactToolDefinition<TP>
ToolReactUtil.registerVariantToolWithPersistentWindows🔗
function ToolReactUtil.registerVariantToolWithPersistentWindows<TP is IToolParam, WPisIToolWindowParam<TP>>(string, function(TP) : string, Recipe<WP>, function(TP) : string, function(TP) : string): ReactToolDefinition<TP>
Type Parameters
TP( isIToolParam)WP( isIToolWindowParam<TP>)
stringfunction(TP): stringRecipe<WP>function(TP): stringfunction(TP): string
ReactToolDefinition<TP>
ToolReactUtil.prepareDefaultToolWithWindowDefinition🔗
function ToolReactUtil.prepareDefaultToolWithWindowDefinition<TP is ToolReactUtil.IToolParam, WPisToolReactUtil.IToolWindowParam<TP>>(string, string, Recipe<WP>, function(TP) : string, function(TP) : string, function(TP) : string): ReactToolDefinition<TP>
Type Parameters
TP( isToolReactUtil.IToolParam)WP( isToolReactUtil.IToolWindowParam<TP>)
stringstringRecipe<WP>function(TP): stringfunction(TP): stringfunction(TP): string
ReactToolDefinition<TP>
ToolReactUtil.DelegatingToolDefinition🔗
interface ToolReactUtil.DelegatingToolDefinition<PublicParam, InternalParam>
delegate: ReactToolDefinition<InternalParam> end
Type Parameters
PublicParamInternalParam
ToolReactUtil.DelegatingToolDefinition.delegate🔗
ToolReactUtil.DelegatingToolDefinition.delegate: ReactToolDefinition<InternalParam>
ToolReactUtil.PushToolEventParam🔗
record ToolReactUtil.PushToolEventParam<TP, DP>
tool: DelegatingToolDefinition<TP, DP> key: string param: TP allowStacking: boolean end
Type Parameters
TPDP
ToolReactUtil.PushToolEventParam.tool🔗
ToolReactUtil.PushToolEventParam.tool: DelegatingToolDefinition<TP, DP>
ToolReactUtil.PushToolEventParam.key🔗
ToolReactUtil.PushToolEventParam.key: string
ToolReactUtil.PushToolEventParam.param🔗
ToolReactUtil.PushToolEventParam.param: TP
ToolReactUtil.PushToolEventParam.allowStacking🔗
ToolReactUtil.PushToolEventParam.allowStacking: boolean
ToolReactUtil.PopToolEventParam🔗
record ToolReactUtil.PopToolEventParam<TP, DP>
tool: DelegatingToolDefinition<TP, DP> key: string end
Type Parameters
TPDP
ToolReactUtil.PopToolEventParam.tool🔗
ToolReactUtil.PopToolEventParam.tool: DelegatingToolDefinition<TP, DP>
ToolReactUtil.PopToolEventParam.key🔗
ToolReactUtil.PopToolEventParam.key: string
ToolReactUtil.registerDelegatingTool🔗
function ToolReactUtil.registerDelegatingTool<PublicParam, InternalParam>(ReactToolDefinition<InternalParam>): DelegatingToolDefinition<PublicParam, InternalParam>
Type Parameters
PublicParamInternalParam
ReactToolDefinition<InternalParam>
DelegatingToolDefinition<PublicParam, InternalParam>
ToolReactUtil.firePushToolEvent🔗
function ToolReactUtil.firePushToolEvent<TP, DP>(PushToolEventParam<TP, DP>)
Type Parameters
TPDP
PushToolEventParam<TP, DP>
ToolReactUtil.firePopToolEvent🔗
function ToolReactUtil.firePopToolEvent<TP, DP>(PopToolEventParam<TP, DP>)
Type Parameters
TPDP
PopToolEventParam<TP, DP>
ToolReactUtil.onPushToolEvent🔗
function ToolReactUtil.onPushToolEvent<TP, DP>(DelegatingToolDefinition<TP, DP>, function(ToolReactUtil.PushToolEventParam<TP, DP>))
Type Parameters
TPDP
DelegatingToolDefinition<TP, DP>function(ToolReactUtil.PushToolEventParam<TP, DP>)
ToolReactUtil.onPopToolEvent🔗
function ToolReactUtil.onPopToolEvent<TP, DP>(DelegatingToolDefinition<TP, DP>, function(ToolReactUtil.PopToolEventParam<TP, DP>))
Type Parameters
TPDP
DelegatingToolDefinition<TP, DP>function(ToolReactUtil.PopToolEventParam<TP, DP>)