View source for Env xen portal

[[File:xen_portal.png|100px|left]]
{{this is a|point entity|name=env_xen_portal|game=Black Mesa}} This is [[xen]] portal that teleports xen fauna. Essentially, this is a duplicate of {{ent|npc_maker}}, but with additional effects and abilities.
{{note|Will not spawn [[NPC]] if [[player]] or NPC blocks this entity. Ignores physics objects.}}
{{bug*|Ignores crouched [[player]], this may cause player to be crushed when this entity is activated.}}

==Keyvalues==
{{KV Targetname}}
{{KV|Start Disabled|intn=StartDisabled|choices|If ''No'' - xen portal will automatically spawn NPC on spawn.
:* <code>0</code>: No
:* <code>1</code>: Yes
}}
{{KV|ForceScheduleOnSpawn|intn=forcescheduleonspawn|string|Name of NPC schedule that we want to play on spawn.}}

{{KV|Entity To Ignore|intn=ignoreentity|target_destination|If set, an entity to ignore when checking if there's room to spawn.}} 

{{KV|Class name of spawned NPC|intn=NPCType|npcclass|Class of all NPCs spawned by this entity.}}

{{KV|Childrens' Name|intn=NPCTargetname|string|[[Targetname]] of all NPCs spawned by this entity.}}
 
{{KV|Childrens' Squad Name|intn=NPCSquadname|string|[[Squads|Squad name]] of all NPCs spawned by this entity.}} 

{{KV|Childrens' Hint Group|intn=NPCHintGroup|string|[[Hint Groups|Hintgroup]] of all NPCs spawned by this entity.}} 

{{KV|Relationship|intn=relationship|string|<[[string]]&#124;[[targetname]] or [[classname]]> <[[string]]&#124;disposition> <[[int]]&#124;rank> 
Changes whether spawned NPCs like or dislike certain others. Used like the [[ai_relationship]] entity, with all spawned NPCs as the subjects. 
This keyvalue is not included in Valve's [[FGD]]s.|nofgd=1}}
: Values for <code>disposition</code> are:
:* <code>D_HT</code>: Hate
:* <code>D_FR</code>: Fear
:* <code>D_LI</code>: Like
:* <code>D_NU</code>: Neutral

{{KV|Weapons|intn=additionalequipment|choices|What weapon each NPC should spawn with.{{note|You still can write any weapon [[classname]], but only these can be used by some NPCs. [[HECU]] marines will get random weapon from the list.}}
:* <code>{{ent|weapon_glock}}</code>: Glock
:* <code>{{ent|weapon_mp5}}</code>: MP5
:* <code>{{ent|weapon_shotgun}}</code>: Shotgun
:* <code>{{ent|weapon_357}}</code>: 357
:* <code>0</code>: Nothing{{important|With ''Nothing'', it will give one of the weapons in random way for [[HECU]] marines, rest NPCs will get nothing.}}
}}

{{KV|Portal Size|intn=size|choices|Portal size we want to use. All versions showcased in this [https://www.youtube.com/watch?v{{=}}oYjpPprJYpQ video].}}
:* <code>80</code>: Default{{note|Same as ''Alien Slave''.}}
:* <code>20</code>: Small Headcrab
:* <code>40</code>: Headcrab
:* <code>80</code>: Alien Slave
:* <code>90</code>: Houndeye
:* <code>100</code>: Alien Grunt
:* <code>110</code>: Bullsquid

{{KV|Sound Name|intn=sound|sound|Sound to use when portal is activated. Name of the GameSound entry for the sound to play. Also supports direct .wav filenames.}}

{{KV|Leap Distance|intn=jump_distance|float|Determines the max distance [[npc_houndeye|houndeye]] can jump out of the portal. Also works with {{ent|npc_houndeye_knockback}} and {{ent|npc_houndeye_suicide}}.}} 

{{KV|Leap Max Horizontal Speed|intn=jump_hmaxspeed|float|Determines the max horizontal speed [[npc_houndeye|houndeye]] can jump out of the portal. Also works with {{ent|npc_houndeye_knockback}} and {{ent|npc_houndeye_suicide}}.}} 

{{KV|Minimum spawn delay|intn=min_delay|float|}} 

{{KV|Maximum spawn delay|intn=max_delay|float|}} 

{{KV BaseNPCMaker}}

==Flags==
{{Fl|16|Fade Corpse|NPC corpse will disappear after a while.}}
{{Fl|32|Infinite Children|If checked - will able to spawn as many as we want.}}
{{Fl|128|Don't Spawn While Visible|If checked -  portal will not activate while player is looking at it.}}
{{Fl|256|Always use radius spawn|This property works only with {{ent|env_xen_portal_template}}.}}
{{Fl|512|Don't preload template models|}}
{{Fl|32768|No DLight|Doesn't work in {{bms|4|nt=2}}. Works in all game versions before [https://store.steampowered.com/news/app/362890/view/4041374038285692702 24 november 2017 year update].}}
{{Fl|65536|Remove after portal fx has finished|{{ModernConfirm|Doesn't work.}}}}
{{Fl|131072|No sound|}}
{{Fl|262144|Jump out (Houndeye Only)|Enable the leap properties if checked.}}
{{Fl|524288|No Warp FX|{{ModernConfirm|Doesn't work.}}}}
{{Fl|1048576|Spawn flying crap|If unchecked - will cause {{ent|env_xen_portal_template}} to spawn portal effects at origin of the entity, not in [[NPC]] spawn point.}}

==Inputs==
{{I|StartPortal|param=void|Activates portal. Copy of ''Spawn'' input.|nofgd=1}}
{{I|InternalStartPortal|param=void|Used by ''StartPortal''/''Spawn'' input for houndeyes to make them jump out. If used separately - it'll spawn NPC with no delay.|nofgd=1}}
{{I|InternalFinishPortal|param=void|Used by ''InternalStartPortal'' input. If used separately - it'll spawn NPC with no delay and xen portal effects.|nofgd=1}}
{{I|Spawn|Spawns an NPC.}}
{{I|Toggle|Toggles the spawner enabled/disabled state.}}
{{I|Enable|Enables the spawner.}}
{{I|Disable|Disables the spawner.}}
{{I|AddMaxChildren|Adds to the number of NPCs that can spawn before the spawner is exhausted. If an exhausted spawner is given some children to spawn, it still wont begin spawning until it is re-enabled with the <code>Enable</code> input.|param=integer}}
{{I|SetMaxChildren|Sets the number of NPCs that can spawn before the spawner is exhausted. If an exhausted spawner is given some children to spawn, it still won't begin spawning until it is re-enabled with the <code>Enable</code> input.|param=integer}}
{{I|SetMaxLiveChildren|Sets the maximum number of NPCs that can be alive at any one time from this spawner.|param=integer}}
{{I|SetSpawnFrequency|Sets how often (in seconds) a new NPC will be spawned.|param=float}}
{{I|Enable|Enable this entity.|param=void}}
{{I|Disable|Disable this entity.|param=void}}

==Outputs==
{{O|OnStartPortal|Fires when portal is started.|param=void}}
{{O|OnFinishPortal|Fires when NPC is spawned.|param=void}}
{{O|OnSpawnNPC|Fired when an NPC is spawned. The activator is the NPC, and the string is the name of the NPC.|param=string}}
{{O|OnAllSpawned|Fired when the spawned is exhausted (all children have been spawned).}}
{{O|OnAllSpawnedDead|Fired when the spawner is exhausted (all children have been spawned) and all spawned children have died.}}
{{O|OnAllLiveChildrenDead|Fired when all spawned children have died. This does not mean the spawned is exhausted, so a new child may be spawned any time after this (unless the maker is disabled).}}

==Dedicated [[ConVars]]==
{{varcom|start}}
{{varcom|cl_envportal_light_on|1|arbitrary number|This toggles lighting from portals. With 1 it is enabled. With 0 it is disabled.}}
{{varcom|cl_envportal_light_col_R|170|arbitrary number|Red color value for lighting from portals.}}
{{varcom|cl_envportal_light_col_G|255|arbitrary number|Green color value for lighting from portals.}}
{{varcom|cl_envportal_light_col_B|80|arbitrary number|Blue color value for lighting from portals.}}
{{varcom|cl_envportal_light_intensity|4000|arbitrary number|Intensity value for lighting from portals.}}
{{varcom|cl_envportal_light_range|512|arbitrary number|Range value for lighting from portals.}}
{{varcom|cl_envportal_light_ttl|1.25|arbitrary number|Time to life value for lighting from portals.}}
{{varcom|end}}

==See also==
*{{ent|env_xen_portal_template}}
*{{ent|env_xen_portal_effect}}
*{{ent|npc_maker}}
*{{ent|npc_template_maker}}
*{{ent|point_template}}