TiMan: Expand the practical source walkthrough and clarify how to use the handler.

2026-10-02T12:32:16Z

Expand the practical source walkthrough and clarify how to use the handler.

TiMan: Add a sourced SOMA guide with explanations and stock-script examples.

2026-10-02T12:17:08Z

Add a sourced SOMA guide with explanations and stock-script examples.

New page

{{shortPageTitle}}

The Highlight Effect Handler briefly sweeps a glow across eligible nearby objects. It scans active physics bodies, checks selected script classes and calls each entity’s _Global_CanBeHighlighted function. The response must supply a Boolean result and the entity ID in global argument 0. On-screen visibility and a minimum light level are also checked.

The stock tool script reads the HighlightActive instance variable. Its _Global_CanBeHighlighted returns that flag and supplies mBaseObj.GetID(); disabling that flag prevents this tool from being accepted by the handler.

== Stock tool eligibility callback ==
<syntaxhighlight lang="cpp">
void _Global_CanBeHighlighted()
{
cScript_SetGlobalReturnBool(mbHighlightActive);
cScript_SetGlobalArgID(0,mBaseObj.GetID());
}
</syntaxhighlight>

== See also ==
* [[HPL3/Scripting/User Modules Overview|User modules]]
* [[HPL3/SOMA/Scripting/Modules Helper|SOMA module helpers]]

[[Category:English]]

← Older revision		Revision as of 12:32, 2 October 2026
Line 4:		Line 4:

	The stock tool script reads the HighlightActive instance variable. Its _Global_CanBeHighlighted returns that flag and supplies mBaseObj.GetID(); disabling that flag prevents this tool from being accepted by the handler.		The stock tool script reads the HighlightActive instance variable. Its _Global_CanBeHighlighted returns that flag and supplies mBaseObj.GetID(); disabling that flag prevents this tool from being accepted by the handler.
		+
		+	== Trace a tool’s highlight setting ==
		+	# Find <code>HighlightActive</code> in <code>editor/userclasses/EntityClasses.def</code>. The tool instance variable is a Boolean with a declared default of true; its description says it controls the highlight effect when the tool is looked at.
		+	# Open <code>script/props/Prop_Tool.hps</code>. The tool reads that instance variable into <code>mbHighlightActive</code> and returns it through the callback below.
		+	# Follow <code>UpdateAddObjects</code> in <code>script/modules/HighlightEffectHandler.hps</code>. It filters for selected stock script classes, requires a mesh and an on-screen entity, and skips entities whose measured light level is below <code>0.1</code>. A true tool flag therefore supplies eligibility; the handler still applies those additional checks.

	== Stock tool eligibility callback ==		== Stock tool eligibility callback ==

HPL3/SOMA/Scripting/Highlight Effect Handler - Revision history

TiMan: Expand the practical source walkthrough and clarify how to use the handler.

TiMan: Add a sourced SOMA guide with explanations and stock-script examples.