HPL3/SOMA/Areas/Datamine Area

From Frictional Wiki
< HPL3‎ | SOMA‎ | Areas
Revision as of 19:25, 8 February 2024 by Lil alex (talk | contribs) (created page with basic information)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Overview

Helper Function: Datamine Handler
Datamining is what happens when the player in SOMA touches a dead person, intercom or other piece of technology and hears the last few moments of data buffer as an audio clip. Most of this is handled automatically by Prop_Datamine and Datamine Area, but there are a few helper functions available.

Properties

Base

  • BlockLineOfSight: Blocks line of sight.
  • EventInstanceTag: A tag used by the event system to group objects.
  • UserVar: Arbitrary user variable. Acessable by calling the script function Entity_GetVar<type>()

Collide Callbacks

  • CC_Entities: A list separated by commas or spaces of all entities that can trigger the callback. player is the player character.
  • CC_Funcs: A list of functions that will run when the area is triggered.

Attachment

  • ParentAttachEntity: The name of an entity that this soundscape is parented to.
  • ParentAttachUseRotation: If the rotation of the parent should affect the soundscape.
  • ParentAttachBody: The name of the body in the parent entity to attach to.
  • ParentAttachLocked: Locks the area to the parent and disables local movement.

Datamine_Area

  • IsBlackBox: Obsolete
  • EffectProp: Entity to apply highlights to

Datamine_General

  • MaxFocusDistance: Max distance the player can be to interact
  • BeepingActive: If beeping should be active from the start [Clarify]
  • FinalSubjectCallback: Callback once the player has heard the final line of the audio
  • DataminingDoneCallback: Callback once the player has exited the datamine
  • DatamineGlow: Should the datamine be highlighted when the player is near?
  • RangeArea: Specify an area; once the player leaves it, the datamine fades.
  • StopAllVoices: If true, all other voices are stopped when the player triggers the datamine.

Datamine_Page_#

  • Page_#_VoiceSubject: Voicehandler Subject to play
  • Page_#_TextCategory: Obsolete
  • Page_#_TextEntry: Obsolete
  • Page_#_Image: Obsolete