The **StarfallEx** standard library — the `hologram`, `render`, `net`, `http`, physics, entity and other libraries/types available inside a Starfall chip. Mirrors [thegrb93.github.io/StarfallEx](https://thegrb93.github.io/StarfallEx/), parsed from the addon source. Grouped by library/type.

AddLaw

StarfallEx

index

player

Allows modifying the player's mouse sensitivity

AdjustMouseSensitivity

defaultSensitivity

localFOV

defaultFOV

Return a number which multiplies the sensitivity. -1 will do nothing but prevent other hooks overriding (Requires a connected HUD).

Called when the engine wants to calculate the player's view (only works if connected to Starfall HUD)

CalcView

znear

zfar

Table containing information for the camera. {origin=camera origin, angles=camera angles, fov=camera fov, znear=znear, zfar=zfar, drawviewer=drawviewer, ortho=ortho table}

Called when the engine wants to calculate the viewmodel position and angle (only works if connected to Starfall HUD)

CalcViewModelView

Original position (before viewmodel bobbing and swaying)

oldPos

Original angle (before viewmodel bobbing and swaying)

oldAng

Called when the player's chat box text changes. Requires the 'input' permission.

ChatTextChanged

Called after a client's starfall has initialized. Use this to know when it's safe to send net messages to the client.

ClientInitialized

Called when a component is linked to the starfall

ComponentLinked

Called when a component is unlinked to the starfall

ComponentUnlinked

Called whenever a CUserCmd is made for the local player. This runs twice per frame, one for movement one for camera. You can use cmd:getCommandNumber to check which one it is if you want to only run on one of them. Camera will have a 0 command number.

CreateMove

Called when a player animation event occurs

DoAnimationEvent

event

data

Called when a frame is requested to be drawn on hud. (2D Context)

DrawHUD

Called after the starfall chip is duplicated and the duplication is finished.

DupeFinished

A table of entities duped with the chip mapped to their previous indices.

entTbl

Called when a player stops driving an entity

EndEntityDriving

Called whenever a sound has been played. This will not be called clientside if the server played the sound without the client also calling Entity:EmitSound.

EntityEmitSound

Information about the played sound. Changes done to this table can be applied by returning true from this hook. See https://wiki.facepunch.com/gmod/Structures/EmitSoundInfo.

Return false to prevent the sound from playing or nothing to play the sound without altering it.

Called every time a bullet is fired from an entity

EntityFireBullets

The bullet data. See http://wiki.facepunch.com/gmod/Structures/Bullet

Optional callback to called as if it were the Bullet structure's Callback. Called before the bullet deals damage with attacker, traceResult.

EntityRemoved

If clientside, will be true if the entity was removed by a fullupdate

fullupdate

EntityTakeDamage

target

attacker

inflictor

amount

type

position

force

Return true to prevent the entity from taking damage

Called when the local player closes their chat window.

FinishChat

Called each UserCmd for each player after their move has been processed.

FinishMove

move

Called when an entity is being dropped by a gravity gun

GravGunOnDropped

Called when an entity is being picked up by a gravity gun

GravGunOnPickedUp

Called when a player punts with the gravity gun

GravGunPunt

Called when the player connects to a HUD component linked to the Starfall Chip

HUDConnected

Called when the player disconnects from a HUD component linked to the Starfall Chip

HUDDisconnected

Called when a hud element is attempting to be drawn

HUDShouldDraw

The name of the hud element trying to be drawn

Called before entities are drawn. You can't render anything, but you can edit hologram matrices before they are drawn.

HologramMatrix

Called when an input on a wired SF chip is written to

Input

input

value

InputBindPressed

bind

Returning true will block the binding from being pressed for the chip owner

InputPressed

button

InputReleased

KeyPress

KeyRelease

Called when a lockdown has ended. DarkRP only.

LockdownEnded

The player who ended the lockdown, or nil.

actor

Called when a lockdown has started. DarkRP only.

LockdownStarted

The player who started the lockdown, or nil.

Called when a player is about to pick a lock. DarkRP only. Will only be called if the lockpicker is the owner of the chip, or if the chip is running in superuser mode.

LockpickStarted

trace

Event hook for midi devices. Everytime a midi device outputs a signal, the callback function on the hook is called. Read up on the MIDI protocol to make better sense of everything -> https://ccrma.stanford.edu/~craig/articles/linuxmidi/misc/essenmidi.html Commands and their parameters: 0x80 NOTE_OFF              : param1 = key;                         param2 = velocity 0x90 NOTE_ON               : param1 = key;                         param2 = velocity 0xA0 AFTERTOUCH            : param1 = key;                         param2 = touch 0xB0 CONTINUOUS_CONTROLLER : param1 = button_number;               param2 = button_value 0xC0 PATCH_CHANGE          : param1 = patch number; 0xD0 CHANNEL_PRESSURE      : param1 = pressure; 0xE0 PITCH_BEND            : param1 = lsb(least signifigant bit);  param2 = msb(most signifigant bit)

MIDI

the exact systime at which the event occurred

time

the command code of the event.  First 4 bits are the command code and last 4 are the channel

command

Each command has their own set of parameters, see above

param1

param2

Called when a money printer is about to catch fire. DarkRP only. Called between moneyPrinterPrintMoney and moneyPrinterPrinted. Not guaranteed to work for non-vanilla money printers. Only works if the owner of the chip also owns the money printer, or if the chip is running in superuser mode.

MoneyPrinterCatchFire

The money printer that is about to catch fire

moneyprinter

Called when a money printer is about to print money. DarkRP only. Not guaranteed to work for non-vanilla money printers. You should use moneyPrinterPrinted instead, as the printer is not guaranteed to print money even if this hook is called. Only works if the owner of the chip also owns the money printer, or if the chip is running in superuser mode.

MoneyPrinterPrintMoney

Called after a money printer is has printed money. DarkRP only. Not guaranteed to work for non-vanilla money printers. Only works if the owner of the chip also owns the money printer, or if the chip is running in superuser mode.

MoneyPrinterPrinted

moneybag

MouseMoved

MouseWheeled

delta

name

Length of the arriving net message in bits

On server, the player that sent the message. Nil on client.

Called when a clientside entity gets created or re-created via lag/PVS

NetworkEntityCreated

Called when a clientside entity transmit state is changed. Usually when changing PVS If you want clientside render changes to persist on an entity you have to re-apply them each time it begins transmitting again

NotifyShouldTransmit

shouldtransmit

Called when the player closes the context menu

OnContextMenuClose

Called when the player opens the context menu

OnContextMenuOpen

Called the next frame after an entity is created

OnEntityCreated

The created entity. May be invalid if deleted before this hook runs.

Called when the Entity:getWaterLevel of an entity is changed.

OnEntityWaterLevelChanged

Called when a player has finished picking a lock, successfully or otherwise. DarkRP only. Will only be called if the lockpicker is the owner of the chip, or if the chip is running in superuser mode.

OnLockpickCompleted

The player attempting to lockpick the entity.

Whether the player succeeded in lockpicking the entity.

success

OnNPCKilled

The NPCs attacker, the entity that gets the kill credit, for example a player or an NPC.

Called when an entity is being frozen Note this is not called for players or NPCs held with the physgun (bug)

OnPhysgunFreeze

physgun

physobj

Called when a player has successfully picked up an entity with their Physics Gun. Not to be confused with PhysgunPickup which is a predicted hook

OnPhysgunPickup

The player that has picked up something using the physics gun.

Called when a player reloads their physgun

OnPhysgunReload

Called when a player makes contact with the ground after a jump or a fall.

OnPlayerHitGround

inWater

Did the player land on an object floating in the water?

onFloater

The speed at which the player hit the ground

speed

OnPlayerJump

Called when an entity is being dropped or thrown by +use

OnPlayerPhysicsDrop

thrown

Called when an entity is being picked up by +use

OnPlayerPhysicsPickup

Called when local client changed instance permissions

PermissionRequest

Called when an entity being held by a physgun gets dropped

PhysgunDrop

Called when an entity gets picked up by a physgun This hook is predicted.

PhysgunPickup

Called when a player's reserve ammo count changes.

PlayerAmmoChanged

ammoID

oldcount

newcount

PlayerCanPickupWeapon

Called when a player has changed team using Player:SetTeam

PlayerChangedTeam

Index of the team the player was originally in. See team.getName and the team library