info_director

From Valve Developer Community
Revision as of 17:38, 11 January 2010 by BitMage (talk | contribs) (The map *can* run without a director, it would just be boring...)

Jump to: navigation, search


<Left 4 Dead> info_director is a point entity available in Left 4 Dead. It is the notorious AI Director, and must exist in every L4D and L4D2 map for normal gameplay.

The director is almost entirely automated and only exists at design-time for the few situations in which other designer-placed entities need to communicate with it, such as for forcing survivors to their respective info_suvivor_position at the start of a campaign for camera intro sequences.

Caveats

Using the changelevel console command to restart the map will cause the director to ignore the forcesurvivorpositions input.
If you are restarting the map after a fresh compile using changelevel and you need to test out your intro sequence, use the kill console command afterwards to have the mission fail, this will cause the map to restart in a way that allows the info_director to use forcesurvivorpositions input, which will also allow your cameras to function.
logic_auto cannot trigger forcesurvivorpositions unless the map was freshly loaded from the game menu as a campaign, or is restarting after mission failure.
To get around this, have the director call forcesurvivorpositions and releasesurvivorpositions on itself using the ongamestart input. When your campaign is ready for release, you can safely change it back to using a logic_auto before final compilation if you wish, since players will be loading your campaign from the game menu.

Keyvalues

Targetname:

Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist> (New with Left 4 Dead 2)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Script think function (thinkfunction) <string> (New with Left 4 Dead 2)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.

Origin:

Origin (X Y Z) (origin) <origin>
The position of this entity's center in the world. Rotating entities typically rotate around their origin.

Inputs

StartIntro
Players are immune to damage while this is active. No mobs or SI will spawn.
FinishIntro
Players will now take damage. Mobs and SI can spawn given that the player is no longer standing in a nav square marked as PLAYER_START and/or CHECKPOINT.
ForceSurvivorPositions
ReleaseSurvivorPositions
Teleport / release the survivors from their starting positions and enable / disable movement.
PanicEvent
Force a panic event.
PanicEventControlled
To do
FireConceptToAny
Allows survivor dialogue to be triggered by map entities (e.g. No Mercy's elevator with parameter hospital04_path4)

Targetname:

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 than Kill.
AddOutput <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile <script> (New with Left 4 Dead 2)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (New with Left 4 Dead 2)
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 <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (New with Alien Swarm) !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.
SetLocalAngles <angles> (New with Alien Swarm) !FGD
Set this entity's angles.

Outputs

OnGameplayStart
Fired when a map loads, all players join and gameplay begins.
OnPanicEventFinished
Fired when a panic event is finished.

Targetname:

OnUser1 to OnUser4
These Outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (Only in the Left 4 Dead series)
This Output fires when the entity is killed and removed from the game.