logic_menulistener
logic_menulistener
is a point entity available in SiN Episodes. Allows maps to respond to player inputs in the main menu. It can be used both when playing a map while having the pause menu open and when on the main menu with a map running as the background. It can fire an output if the player either hovers or presses a button of a specific type on the menu. This entity was originally planned for use in the background maps during a normal startup of the game but was cut for unknown reasons, but can be thought of being too annoying for the end user. It can still be enabled in a background map by making sure 'background01' is loaded as it is the only background map with this by default, then type into the console 'sv_cheats 1; ent_fire relay_NewGame enable' which will temporarily enable it until map reloading.
Keyvalues
Targetname:
- Name
(targetname)
<string> - The targetname that other entities refer to this entity by.
Inputs
Base:
AddContext
<string>- Adds to the entity's list of response contexts. See Context.
AddOutput
<string>- Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"
// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"
|
ClearContext
- Removes all contexts from this entity's list.
ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1
toFireUser4
- Fires the respective
OnUser
outputs; see User Inputs and Outputs.
Kill
- Removes this entity and any entities parented to it from the world.
KillHierarchy
- Functions the same as
Kill
, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKill
input.
RemoveContext
<string>- Remove a context from this entity's list. The name should match the key of an existing context.
SetParent
<string>- Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment
<string>- Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset
<string>- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
DispatchResponse
<string> !FGD- Dispatches a response to the entity. See Response and Concept.
DispatchEffect
<string> (removed since ) !FGD- Dispatches a special effect from the entity's origin; See also List of Client Effects. Replaced by the particle system since .
RunScriptFile
<скрипт> (in all games since ) (also in )- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode
<string> (in all games since ) (also in )- Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console. Bug:In Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.Fix:Remove the string argument manually with a text editor.
CallScriptFunction
<string> (in all games since ) (also in ) !FGD- Calls a VScript function defined in the scope of the receiving entity.
TerminateScriptScope
(only in ) !FGD- Destroys the script scope of the receving entity.
SetLocalOrigin
<coordinates> (in all games since ) !FGD- Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
Outputs
ResumeGameMousedOver
ResumeGamePressed
- Fires if the user clicks/hover on 'Resume Game'.
NewGameMousedOver
NewGamePressed
- Fires if the user clicks/hover on 'New Game'.
OptionsMousedOver
OptionsPressed
- Fires if the user clicks/hover on 'Options'.
LoadGameMousedOver
LoadGamePressed
- Fires if the user clicks/hover on 'Load Game'.
SaveGameMousedOver
SaveGamePressed
- Fires if the user clicks/hover on 'Save Game'.
StatsMousedOver
StatsPressed
- Fires if the user clicks/hover on 'Stats'.
FriendsMousedOver
FriendsPressed
- Fires if the user clicks/hover on 'Friends'.
QuitMousedOver
QuitPressed
- Fires if the user clicks/hover on 'Quit'.
Targetname:
OnUser1
toOnUser4
- These outputs each fire in response to the firing of the like-numbered
FireUser1
toFireUser4
Input; see User Inputs and Outputs.
OnUse
- Fired when the
Use
input is given.