package.facepunch.sandbox

Tracks which connection spawned this object

I would fucking love to be able to Sync these.. And it would just do this exact behaviour. Why not?

Provides animation parameters and helpers for behaviors. Also handles look-at (eyes/head) and body turning via animator parameters.

Current world-space target the Npc is looking at (if any).

Set both eye and head aim using a single local-space direction.

Command this layer to look at a target

Stop looking

Check if we're facing the target sufficiently.

Update look direction - handles head/eye tracking and rotates the body when needed.

A behavior layer provides specific services for tasks to use -- we don't use behavior layers for state, they are services.

Called when the layer is created

Called each frame to update the layer

Reset the layer state

Handles Npc navigation

Command this layer to move to a target

Check if we've reached our target

Handles awareness and environmental scanning

Scan for objects of interest

Check if we have line of sight to target

Get the nearest visible

All layers in this npc

Senses layer - handles environmental awareness and target detection

Navigation layer - handles pathfinding and movement

Animation layer - handles look-at and animation parameters

Creates, initializes, and adds a new layer of the specified type to the collection of layers. Generally called in the constructor of the NPC.

The current running schedule for this NPC.

Get a schedule -- if it doesn't exist, one will be created

Updates a behavior, returns if there is an active schedule - this will stop lower priority behaviors from running

End the current schedule cleanly

A schedule -- can be understood as a way to execute a sequence of tasks

Initialize the schedule with the Behavior context

Called when task is ended because of ShouldCancel returning true

Called every frame while schedule is running

Called once when schedule ends

Called when this schedule starts -- this is where you can add tasks to run

Called when this schedule ends -- this is where you can clean stuff up

Add a task to the sequence

Start the current task in sequence

Information about this schedule for debugging purposes

Simple flee - just move away quickly, then complete

Should this be a nice helper?

A task

What is the current status of this task?

Status returned by task execution

Task is still running, continue executing

Task completed successfully

Task failed or was cancelled

Task was interrupted by conditions

Tells the AnimationLayer to face a target position or object

Task that commands the NavigationLayer to move to a target

Task that waits for a specified duration

This component has a kill icon that can be used in the killfeed, or somewhere else.

If true, the notice won't auto-dismiss. Call to remove it.

Dismiss a manual notice, causing it to slide out and be deleted.

Send a notice to a specific connection. Must be called from the host.

Rebuild if the owner connection changes

update every second

Creates a bunch of other common effects

Shake the screen in a roll motion

The currently selected value of any sub-menus

The type of ammo this resource represents

The maximum amount of ammo that can be held

Returns an analog value between 0 and 1 representing how much the input is pressed

Returns true if button is currently held down

Returns true if button was released

Returns true if button was pressed

If this entity uses code then you should enable this so the code is included when publishing.

Cleans up all spawned props and entities from every player. Admin only.

Cleans up all props and entities spawned by the local player.

Execute this utility function for the given player.

Return false to hide this function from the menu.

Wether this weapon should be avoided when determining an item to swap to

If true the game should hide the hud when holding this weapon. Useful for cameras, or scopes.

The value of this weapon, used for auto-switch.

Gets a reference to the weapon model for this weapon - if there's a viewmodel, pick the viewmodel, if not, world model.

The owner of this carriable

Where shoot effects come from. Either the point on the world model or the viewmodel, whichever is currently being used.

Can we switch to this?

Called when added to the player's inventory

Called when this is pulled out

Called when this is put away

Called every frame, when active

Called every frame, on the owning player's client.

Called every update, scoped to the owning player

Called when setting up the camera - use this to apply effects on the camera based on this carriable

Can directly influence the player's eye angles here

Run a trace related attack with some set information. This is targeted to the host who then does things.

Is this item currently being used? When true, prevents auto-switching away on item pickup etc.

Info about a trace attack. It's a struct so we can add to it without updating params everywhere.

Constructs a from a trace and input damage.

Does this weapon consume ammo at all?

Is this weapon ammo for itself? eg tripmine, grenades

The for this weapon

Does this weapon use clips?

When reloading, we'll take ammo from the player as much as we can to fill to this amount.

The default amount of bullets in a weapon's magazine on pickup. This can differ to the max size.

StartingAmmo defines how much ammo we'll give to the player on pickup.

How long does it take to reload?

Can we switch to this gun?

Takes ammo from the player's inventory

Do we have ammo for the weapon's ammo type?

Do we have ammo for a specific ammo type? Useful if a weapon has an alt fire.

Should we consume 1 bullet per reload instead of filling the clip?

Can we cancel reloads?

How long after deploying a weapon can you not shoot a gun?

How long until we can shoot again

Adds a delay, making it so we can't shoot for the specified time

The dry fire sound if we have no ammo

Play a dry fire sound. You should only call this on weapons that can't auto reload - if they can, use instead.

Player has fired an empty gun - play dry fire sound and start reloading. You should only call this on weapons that can reload - if they can't, use instead.

Override to perform the weapon's primary attack. Default no-op.

Override to perform the weapon's secondary attack. Default no-op.

Determines if the primary attack should trigger

Determines if the secondary attack should trigger

Override the primary fire rate

Override the secondary fire rate

Throwable type

Is this a throwable?

The throwable type

Turns on incremental reloading parameters.

Animation speed in general.

Animation speed for incremental reload sections.

How much inertia should this weapon have?

Called when starting to reload a weapon.

Called when incrementally reloading a weapon.

Called when someone leaves the server. This will only be called for the host.

In the editor, spawn the player where they're looking

Find the most appropriate place to respawn

Called on the host when a played is killed

Change a property, remotely

The local user's preferences in Deathmatch

Enables automatic switching to better weapons on item pickup

Enables fast switching between inventory weapons

Intensity of your camera's screenshake

A pickup that gives the player ammo.

Which ammo we give the player

The quantity of ammo

A weapon, or weapons, or ammo, that can be picked up

The pickup's collider, it is required

The sound to play when picking up this item

Check if the player can pick up this object

Give the player the effect of this pickup

Should this object be consumed, eg on successful pickup

Called when a gameobject enters the trigger.

A pickup that gives the player some health.

How much health to give to the player

A pickup that gives an inventory item, like a weapon

A list of prefabs (that have to be inventory items) that are given to the player

The toggle state has changed

The button's behavior mode.

Normal toggle button - click to turn on, click again to turn off.

Button is only on while being held down.

Button briefly turns on then immediately off when pressed.

Animation curve to use, X is the time between 0-1 and Y is how much the button is pressed from 0-1.

How long in seconds should it take to animate this button.

Sound to play when the button is pressed.

Sound to play when the button is released.

Called when the button's state changes.

True if the button is currently on

True if the button is currently animating

Turns the button on. Does nothing if already on or animating.

Turns the button off. Does nothing if already off or animating.

Toggles the button between on and off states.

Animation curve to use, X is the time between 0-1 and Y is how much the door is open to its target angle from 0-1.

Sound to play when a door is opened.

Sound to play when a door is interacted with while locked.

Sound to play when a door is fully opened.

Sound to play when a door is closed.

Sound to play when a door has finished closing.

Optional pivot point, origin will be used if not specified.

How far should the door rotate.

How long in seconds should it take to open this door.

Open away from the person who uses this door.

The door's state

Is this door locked?

Called when the door's state changes. When it opens, closed, is closing, etc..

Opens the door. Does nothing if already open or opening.

Closes the door. Does nothing if already closed or closing.

Toggles the door between open and closed states.

Moves and Rotates an Object.

If not empty, the target must have one of these tags

If not empty, the target must not have one of these tags

If true, the player will still collide with the world and other players. This probably means that the noclip mode is named wrong. But it's cool. It just becomes a fly around mode.

Holds player information like health

Find a player for this connection

Get player from a connecction id

Kill yourself

Give all items (sv_cheats should be 1)

Switch to another map

Access the undo system for this player

True if the player wants the HUD not to draw right now

Try to inherit transforms from the player onto its new ragdoll

Creates a ragdoll but it isn't enabled

Broadcasts death to other players

Called on the host when a player dies

Holds persistent player information like deaths, kills

Unique Id per each player and bot, equal to owning Player connection Id if it's a real player.

Is this player data me?

Data for all players

Get player data for a player

Get player data for a player's id

Called on the host, calls a RPC on the player and adds a stat

Called only on the Player's GameObject for their actions or events

Broadcasted to the entire scene on the local player's actions or events

Apply fall damage to the player

Fatal fall speed, you will die if you fall at or above this speed

Maximum safe fall speed, you won't take damage at or below this speed

Multiply damage amount by this much

Fall damage sound

Describes a player gib.

Dead players become these. They try to observe their last corpse.

Record stats for the local player

Get the undo stack for a specific SteamId

Per-player undo stack

Create a new undo entry

Run the undo

An undo entry

The name of the undo, should fit the format "Undo something". Like "Undo Spawn Prop".

Add a GameObject that should be destroyed when the undo is undone

Run this undo

This component has a kill icon that can be used in the killfeed, or somewhere else.

Creates a bunch of callbacks, allowing finer control over applying camera effects

A typed sort mode for finding packages.

Returns the API supported string equivalent of this sort mode.

Only play the collision sound from this object's surface - not both the impacting surface and this surface.

We want to control the camera fov

The force applied to pull objects to us.

The force applied when launching grabbed objects.

The distance at which we'll grab an object when pulling it towards us.

Lets tools define what constraints should be removed when removing constraints from a game object.

Holds a bunch of GameObject json, a bounding box, and some preview models for a duplication. This is what gets serialized to a string and stored in the Duplicator tool. The objects and the bounds are created in selection space. Where the user right clicked to select is 0,0,0, and the player's view yaw is the rotation identity.

An array of JsonObject objects, which are serialzed GameObjects

The bounds are used to work out where to place the duplication, so it doesn't clip through the floor.

Describes where to draw a model for the preview

A list of preview models to help visualze where the duplication will be placed

Packages used in this

Create DuplicationData from a bunch of objects. center is the transform to use as the origin for the duplication. The rotation of center should be the player's view yaw when they made the selection.

Render duplicator Json to a bitmap

When we right click, to "copy" something, we create a Duplication object and serialize it to Json and store it here.

This is created in JsonChanged.

Have all packaged finished loading.

Save the current dupe to storage.

Adds a GameObject. Won't find connections.

Add a GameObject with all connected GameObjects

While the client input is active we'll apply thrust

A point in the world selected by the current player's toolgun. We try to keep this as minimal as possible while catering for as much as possible.

Returns true if GameObject is valid - which means we hit something

Returns the position of the hit - in the world space. This is the transformed position of the LocalTransform relative to the GameObject.

Returns the transform of the hit

Returns true if this object is a part of the static map

Returns true if this object is a player

Get a SelectionPoint from the tool gun owner's eyes.

Given a clicked point on a, and a clicked point on b, return a transform that places the objects so the points are touching

The mode should set this true or false in OnControl to indicate if the current state is valid for performing actions.

Current tool info that we'll show on the HUD

Used for hints in the UI, describes how to use a tool mode.