Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DIYScriptFunctions

Hierarchy

  • DIYScriptFunctions

Index

Methods

create

  • create(diy: DIY): void
  • Called when the DIY component is first created. This is used to set up the component's basic features (face style, base key, etc.). This method and onRead are the only places where these values can be changed without throwing an exception.

    Parameters

    • diy: DIY

      the component

    Returns void

createBackPainter

  • Called to set up any objects needed to paint the component's back face(s).

    Parameters

    • diy: DIY

      the component

    • sheet: DIYSheet

      the sheet representing the face in question

    Returns void

createFrontPainter

  • Called to set up any objects needed to paint the component's front face(s).

    Parameters

    • diy: DIY

      the component

    • sheet: DIYSheet

      the sheet representing the face in question

    Returns void

onClear

  • onClear(diy: DIY): void
  • Called when the user wants to reset the component to a blank state.

    Parameters

    • diy: DIY

      the component

    Returns void

onRead

onWrite

  • Called when the component is being written to a file after all regular content has been saved.

    Parameters

    Returns void

paintBack

  • Called to paint content on the component's back face(s).

    Parameters

    Returns void

paintFront

  • Called to paint content on the component's front face(s).

    Parameters

    Returns void