Difference between revisions of "HPL3/SOMA/Scripting/Scripting Api/Readable"

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting‎ | Scripting Api
Jump to navigation Jump to search
(Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte...")
 
(No difference)

Latest revision as of 22:58, 24 August 2020

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Summary

Return Type Function and Description
void Readable_SetCloseCallback(const tString &in asName, const tString &in asCallback)
Sets the close callback of a readable prop
void Readable_SetOpenEntityFile(const tString &in asName, const tString &in asEntityFile)
Sets the open entity file of the readable prop

Function Detail

Readable_SetCloseCallback

void Readable_SetCloseCallback(const tString &in asName,
                               const tString &in asCallback)

Sets the close callback of a readable prop.
Syntax for callback function: void FuncName(const tString &in asEntity).

Parameters

  • asName (tString) — name of readable prop
  • asCallback (tString) — the callback function

Returns:

  • void

Readable_SetOpenEntityFile

void Readable_SetOpenEntityFile(const tString &in asName,
                                const tString &in asEntityFile)

Sets the open entity file of the readable prop

Parameters

  • asName (tString) — name of readable prop
  • asEntityFile (tString) — the new entity file name

Returns:

  • void