HPL2/AMFP/NewEntities

New Entity Types

MFP features a few new entity types.

PhoneBox

The entity which executes phone calls. There's only one such asset in the game, and the entity file doesn't have any type vars (User Defined Variables). However, in the Level Editor, it has multiple instance vars.

Instance Vars (All Props) Expand

Name	Type	Default	Description
CastShadows	Bool	true	If entity casts shadows.
StaticPhysics	Bool	false	If the mass of all bodies should be 0. If enabled, the entity cannot be moved by physics or player interactions.
IsOccluder	Bool	false	If objects behind should be culled.
IsAffectedByDecal	Bool	true	If decals can be created on entity.
CallbackFunc	String		A callback function used for a number of events. Syntax: void Func(string &in asEntityName, string &in asType). asType can be OnPickup, Break, OnIgnite
ConnectedProps	String		Props that are connected to this entity and what will happen will depend upon type of prop and what happens. OnBreak makes the connected props active and gives them an impulse. Enter with space and/or comma between entity names.
ConnectionStateChangeCallback	String		A callback called when ever the connection state changes (button being switched on). Syntax: void Func(string &in asEntityName, int alState). alState: -1=off, 0=between, 1=on
FullGameSave	Bool	false	If the all things in the entity should be saved when exiting the level. Only use on few entities! If enabled, additional entity properties are saved, such as the open amount of SwingDoors.
PlayerLookAtCallback	String		Callback called when player looks at entity. Syntax: void Func(string &in asEntity, int alState) alState: 1=looking, -1=stopped looking
PlayerLookAtCallbackAutoRemove	Bool	false	Should look at callback be removed when entity is looked at and callback called.
PlayerInteractCallback	String		Callback called when player interacts with entity. Syntax: void Func(string &in asEntity)
PlayerInteractCallbackAutoRemove	Bool	false	Should interact callback be removed when entity is interacted with and is callback called.
GlowEnabled	Bool	true	If the object should have a glowing effect. Only works on interactables!
GlowColor	Color	0.5 0.5 1.0 0	Color of the objects glow.
GlowOutlineColor	Color	0 0 0.5 0	Color of the outline when object is in focus
UpdateAnimationWhenCulled	Bool	false	Should the animation be reset when the player isn't looking.

Instance Vars

Name	Type	Default	Description
VoiceFile1	File (.ogg)		The sound file to play. The file has to be located in the sounds folder or one of its subfolders.
TextEntry1	String		First subtitle lang entry. Category must be 'Voice'.
Delay1	Float	0	Time until the first subtitle is displayed.
TextEntry2	String		Second subtitle lang entry. Category must be 'Voice'.
Delay2	Float	0	Time until the second subtitle is displayed.
TextEntry3	String		Third subtitle lang entry. Category must be 'Voice'.
Delay3	Float	0	Time until the third subtitle is displayed.
TextEntry4	String		Fourth subtitle lang entry. Category must be 'Voice'.
Delay4	Float	0	Time until the fourth subtitle is displayed.
TextEntry5	String		Fifth subtitle lang entry. Category must be 'Voice'.
Delay5	Float	0	Time until the fifth subtitle is displayed.
TextEntry6	String		Sixth subtitle lang entry. Category must be 'Voice'.
Delay6	Float	0	Time until the sixth subtitle is displayed.
TextEntry7	String		Seventh subtitle lang entry. Category must be 'Voice'.
Delay7	Float	0	Time until the seventh subtitle is displayed.

Not all 7 entries must be used, but there can't be more than that in a single phonecall.

The PhoneBox entity has two dedicated functions for it:

void StartPhoneRinging(string &in asPhonebox);
void StopPhoneRinging(string &in asPhonebox);

1. asPhonebox - The phone box entity to use.

The PhoneBox won't ring until the StartPhoneRinging function is called. StopPhoneRinging can be used if the player leaves an area without picking up the phone, or takes too long.

When StartPhoneRinging is used, the PhoneBox will start ringing (the sound is only audible at a quite short distance, and a bell animation will play). A unique crosshair when looking at the PhoneBox. Interacting with it will play a switch animation as well as the voice file, and display all the defined subtitles at specified intervals. After the voice file finishes playing, another switch animation will play and the glow will disappear (if it was used).

Keep in mind that the green light which appears on the PhoneBox is not a part of the entity; it's a Lamp entity which needs to be enabled by scripting.

Enemy_ManPig

This enemy type has multiple new settings in the LevelEditor. They are all documented in the editor hover-hints, but some of them require additional explanations:

• Hallucination - uses enemy_hallucination_disappear.snt, which isn't in the game files but could be modded in. The hallucination effect now consist of some organic particles instead of the TDD dust particle.
• Pose - determines whether the enemy will move and attack upright or on all fours.
• ThreatenOnAlert - if ticked, the enemy will play an additional animation before chasing/fleeing from the player.
• FleeFromPlayer - the enemy will run away when it notices the player. Running to the furthest pathnode seems to be the main behaviour. The monster will still attack if the player comes too close or encounters the monster after it fled.

Warning: Before setting this as true, make sure that your level has PathNodes - otherwise the game will crash when the monster notices the player!

• AutoDisableAfterFlee - if the monster flees and can't be seen by the player anymore, it will disappear.
• IdleBehaviour - determines what the enemy does when not engaged or patrolling (or when there are no patrol nodes left to walk to). Options are:
  1. None - the enemy will stand in place.
  2. Stalk - the enemy will walk and on occassions run from node to node, sometimes also pausing along the way.
  3. Track - unspecified behaviour. Might be broken, unfinished, or dependant on particular circumstances. Testing resulted in same behaviour as None.

Enemy_Child

It is an enemy variation used for acting out scenes. It has some of the Pig enemy settings. However, most of them seem to have no effects.

This "enemy" doesn't seem to respond to any player input, asides from proximity.

It also has a lot of Level Editor settings (statements marked with (?) marks haven't been confirmed):

• AutoRemoveAtPathEnd - If enemy should be removed when it reaches the end of the path.
• AutoReverseAtPathEnd - If enemy should turn around (?) when it reaches the end of the path.
• IsOccluder - function unknown, possibly related to rendering or lighting
• AutoRemoveMinPlayerDistance - At what distance from the player to remove the NPC (?)
• Invisible, Blind, Deaf - don't seem to have any effect.
• DamageMul - Doesn't seem to be useful since Child NPCs don't even have attack animations.
• RunSpeedMul - Multiplier; how many times faster than in the entities' settings (?) should the enemy run
• PatrolMoveSpeed - Whether this NPC walks or runs along its patrol. One of the few ManPig settings which has actual effects in this entity type.

AnimatedProp

This type doesn't seem to have any particular use. It is unclear why it was added, as.dae with animations will play automatically anyway, and PlayPropAnimation() isn't used with AnimatedProps.

Instance Vars

Name	Type	Default	Description
CastShadows	Bool	true	If entity casts shadows.
IsAffectedByDecal	Bool	true	If decals can be created on entity.

VoiceFlashbackTrigger

It's the type of all entities from entities/voice_triggers. It seems that these entities weren't used in any of the maps, which makes this entity type unrestorable.

Note: This entity type is patched in the custom config so that it doesn't give errors when loaded into the editor. However, the intended functionality cannot be used and the editors will only show generic settings for the entity.