Clientside Hooks

Description

Called when the view should be calculated.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 origin Unknown Missing description for origin.
3 angles Unknown Missing description for angles.
4 fov Unknown Missing description for fov.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the calc view table should be adjusted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a cash entity is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the character screen's faction characters should be sorted.

Parameters

# Name Type Note
1 faction Unknown Missing description for faction.
2 a Unknown Missing description for a.
3 b Unknown Missing description for b.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the chat box is closed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the chat box has had a key code typed in.

Parameters

# Name Type Note
1 code Unknown Missing description for code.
2 text Unknown Missing description for text.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the chat box text has changed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the chat box text has been typed.

Parameters

# Name Type Note
1 text Unknown Missing description for text.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when chat text is received from the server

Parameters

# Name Type Note
1 index Unknown Missing description for index.
2 name Unknown Missing description for name.
3 text Unknown Missing description for text.
4 class Unknown Missing description for class.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the directory is rebuilt.

Parameters

# Name Type Note
1 panel DPanel The directory panel.

Return Values

None.

Description

Called when the local player's move data is created.

Parameters

# Name Type Note
1 userCmd Unknown Missing description for userCmd.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the top bars should be destroyed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the player info text should be destroyed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the target player's text should be destroyed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a generator's target ID is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's crosshair should be drawn.

Parameters

# Name Type Note
1 x Unknown Missing description for x.
2 y Unknown Missing description for y.
3 color Unknown Missing description for color.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's screen damage should be drawn.

Parameters

# Name Type Note
1 damageFraction Unknown Missing description for damageFraction.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the target's status should be drawn.

Parameters

# Name Type Note
1 target Unknown Missing description for target.
2 alpha Unknown Missing description for alpha.
3 x Unknown Missing description for x.
4 y Unknown Missing description for y.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the GUI mouse has been released.

Parameters

None.

Return Values

None.

Description

Called when a gear entity is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a generator entity is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Finds the location of the player and packs together the info for observer ESP.

Parameters

# Name Type Note
1 info Table The current table of ESP positions/colors/names to add on to.

Return Values

None.

Description

Called when the top bars are needed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the character panel weapon model is needed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the character panel tool tip is needed.

Parameters

# Name Type Note
1 panel Unknown Missing description for panel.
2 character Unknown Missing description for character.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the character panel weapon model is needed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

This function is called when custom character buttons are needed.

Parameters

# Name Type Note
1 character Table The character whose buttons are needed.
2 buttons Table The currently available buttons.

Return Values

None.

Description

This function is called when custom character options are needed.

Parameters

# Name Type Note
1 character Table The character whose options are needed.
2 options Table The currently available options.
3 menu Table The menu itself.

Return Values

None.

Description

Called when information about a door is needed.

Parameters

# Name Type Note
1 door Unknown Missing description for door.
2 information Unknown Missing description for information.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when an entity's menu options are needed.

Parameters

# Name Type Note
1 entity Entity The entity that is being checked for menu options.
2 options Table The table of options for the entity.

Return Values

None.

Description

Called when a model selection's sequence is needed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a model selection's weapon model is needed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's character screen faction is needed.

Parameters

# Name Type Note
1 character Unknown Missing description for character.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called to get whether the local player's character screen is visible.

Parameters

# Name Type Note
1 panel Unknown Missing description for panel.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's crosshair info is needed.

Parameters

# Name Type Note
1 info Unknown Missing description for info.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player's door access name is needed.

Parameters

None.

Return Values

None.

Description

Called when extra player info is needed.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 text Unknown Missing description for text.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

This function is called when local player info text is needed and adds onto it (F1 menu).

Parameters

# Name Type Note
1 playerInfoText Table The current table of player info text to add onto.

Return Values

None.

Description

Called when the local player's limb info is needed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player's scoreboard class is needed.

Parameters

# Name Type Note
1 player Unknown Missing description for player.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player's scoreboard options are needed.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 options Unknown Missing description for options.
3 menu Unknown Missing description for menu.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player's scoreboard text is needed.

Parameters

# Name Type Note
1 player Unknown Missing description for player.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player's status info is needed.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 text Unknown Missing description for text.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

This function is called when the player's fade distance is needed for their target text (when you look at them).

Parameters

# Name Type Note
1 player Table The player we are finding the distance for.

Return Values

# Name Type Note
1 No name provided Number The fade distance, defaulted at 4096.

Description

Called when the target player's name is needed.

Parameters

# Name Type Note
1 player Unknown Missing description for player.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

This function is called when the targeted player's target text is needed.

Parameters

# Name Type Note
1 player Table The player we are finding the distance for.
2 targetPlayerText Table The player's current target text.

Return Values

None.

Description

A function to get the color of a value from green to red.

Parameters

# Name Type Note
1 value Unknown Missing description for value.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a weapon's lowered view info is needed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called to display a HUD notification when ammo has been picked up. (Used to override GMOD function)

Parameters

# Name Type Note
1 ... Optional Various other optional parameters.

Return Values

None.

Description

Called to display a HUD notification when an item has been picked up. (Used to override GMOD function)

Parameters

# Name Type Note
1 ... Optional Various other optional parameters.

Return Values

None.

Description

Called when the character loading HUD should be painted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player's HUD should be painted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the top screen HUD should be painted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a HUD element should be drawn.

Parameters

# Name Type Note
1 name Unknown Missing description for name.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called to display a HUD notification when a weapon has been picked up. (Used to override GMOD function)

Parameters

# Name Type Note
1 ... Optional Various other optional parameters.

Return Values

None.

Description

Called when an item entity is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called each frame that an item entity exists.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when an item's network data has been updated.

Parameters

# Name Type Note
1 itemTable Unknown Missing description for itemTable.
2 newData Unknown Missing description for newData.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the menu's items should be adjusted.

Parameters

# Name Type Note
1 menuItems Unknown Missing description for menuItems.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the menu's items should be destroyed.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a notification should be adjusted.

Parameters

# Name Type Note
1 info Unknown Missing description for info.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player says something.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 text Unknown Missing description for text.
3 teamOnly Unknown Missing description for teamOnly.
4 playerIsDead Unknown Missing description for playerIsDead.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called before the item entity's target ID is drawn. Return false to stop default draw.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's business item should be adjusted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's class model info should be adjusted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's colorify should be adjusted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's headbob info should be adjusted.

Parameters

# Name Type Note
1 info Unknown Missing description for info.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's item functions should be adjusted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's item menu should be adjusted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's motion blurs should be adjusted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player presses a bind.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 bind Unknown Missing description for bind.
3 bPress Unknown Missing description for bPress.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's business is rebuilt.

Parameters

# Name Type Note
1 panel DPanel The player's business panel.
2 categories Table The categories for the player's business.

Return Values

None.

Description

Called when the local player attempts to see the top bars.

Parameters

# Name Type Note
1 class Unknown Missing description for class.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player attempts to see a business item.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player attempts to see a class.

Parameters

# Name Type Note
1 class Unknown Missing description for class.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player's name should be shown as unrecognised.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 x Unknown Missing description for x.
3 y Unknown Missing description for y.
4 color Unknown Missing description for color.
5 alpha Unknown Missing description for alpha.
6 flashAlpha Unknown Missing description for flashAlpha.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's character screen is created.

Parameters

# Name Type Note
1 panel Unknown Missing description for panel.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's storage is rebuilt.

Parameters

# Name Type Note
1 panel DPanel The player's storage panel.
2 categories Table The categories for the player's inventory.

Return Values

None.

Description

Called before the local player's storage is rebuilt.

Parameters

# Name Type Note
1 panel DPanel The player's storage panel.

Return Values

None.

Description

Called when the local player's default colorify should be set.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player should show on the door access list.

Parameters

None.

Return Values

None.

Description

Called when a player should show on the scoreboard.

Parameters

None.

Return Values

None.

Description

Called when a player starts using voice.

Parameters

# Name Type Note
1 player Unknown Missing description for player.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the local player's storage is rebuilt.

Parameters

# Name Type Note
1 panel DPanel The player's storage panel.
2 categories Table The categories for the player's storage.

Return Values

None.

Description

Called just after a bar is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called just after the date time box is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called just after the local player's information is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called just after the translucent renderables have been drawn.

Parameters

# Name Type Note
1 bDrawingDepth Unknown Missing description for bDrawingDepth.
2 bDrawingSkybox Unknown Missing description for bDrawingSkybox.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called after the view model is drawn.

Parameters

# Name Type Note
1 viewModel Entity The viewmodel being drawn.
2 player Player The player drawing the viewmodel.
3 weapon Weapon The weapon table for the viewmodel.

Return Values

None.

Description

Called to get whether or not a post process is permitted.

Parameters

# Name Type Note
1 class Unknown Missing description for class.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called just before a bar is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called just before the local player's information is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the scoreboard's player info should be adjusted.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the scoreboard's class players should be sorted.

Parameters

# Name Type Note
1 class Unknown Missing description for class.
2 a Unknown Missing description for a.
3 b Unknown Missing description for b.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a shipment entity is drawn.

Parameters

None.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when the character fault should be drawn.

Parameters

# Name Type Note
1 fault Unknown Missing description for fault.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called to get whether a player's target ID should be drawn.

Parameters

# Name Type Note
1 player Unknown Missing description for player.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player begins typing.

Parameters

# Name Type Note
1 team Unknown Missing description for team.

Return Values

# Name Type Note
1 No name provided Unknown No note provided

Description

Called when a player presses a bind at the top level.

Parameters

# Name Type Note
1 player Unknown Missing description for player.
2 bind Unknown Missing description for bind.
3 bPress Unknown Missing description for bPress.

Return Values

# Name Type Note
1 No name provided Unknown No note provided