Hooks Client - Chessnut/NutScript GitHub Wiki

Information

The following are client-side hooks. Similar to server-sided hooks, they are defined by: function SCHEMA:HookName(arguments). Again, plugins follow a similar pattern, but SCHEMA is replaced with PLUGIN.


  • void "LoadFonts" Font's Name
    This hook get fired when the script loads the font.

  • void "BuildHelpMenu" Panel Object
    The developer can use this hook to build the help menu.

  • void "CreateCharInfoText" Panel Object
    The developer can use this hook to add more information on F1 screen.

  • void "CreateCharInfo" Panel Object
    The developer can use this hook to add more information on F1 screen.

  • void "OnCharInfoSetup" Panel Object
    The developer can use this hook to add more information on F1 screen.

  • void "CreateMenuButtons" Panel Object
    The developer can use this hook to build main menu buttons.

  • void "ShowPlayerOptions" Player Panel Object
    This hook is called when player pressed character’s avatar in scoreboard.

  • void "LoadIntro"
    This hook is called before character menu is created.

  • void "DrawEntityInfo" Target Entity Drawing Alpha
    The developer can use this hook to display/draw something on screen when player is looking at the entity.

  • float "AdjustBlurAmount" Blur Goal
    The developer can adjust screen’s blur with this hook.

  • string "GetDisplayedName" Target Entity
    This hook gets the name of the entity’s name.

  • void "ItemShowEntityMenu" Target Entity
    This hook is called when player press E on the item.

  • string "WeaponCycleSound"
    This hook gets the sound’s path for cycling the weapon.

  • string "WeaponSelectSound"
    This hook gets the sound’s path for selecting the weapon.