package.base

Used to control the Citizen animation state. You don't have to use this to animate your citizen avatar, but our aim is to put everything you need in this class, so you can easily see what variables are available.

The skinned model renderer that we'll apply all parameters to.

Where are the eyes of our character?

How tall are we?

Are we looking at something? Useful for stuff like cutscenes, where you want an NPC to stare at you.

Which GameObject should we be looking at?

IK will try to place the limb where this GameObject is in the world.

The transform of the eyes, in world space. This is worked out from EyeSource is it's set.

Have the player look at this point in the world

Have the player animate moving with a set velocity (this doesn't move them! Your character controller is responsible for that)

Animates the wish for the character to move in a certain direction. For example, when in the air, your character will swing their arms in that direction.

Where are we aiming?

The weight of the aim angle, but specifically for the Citizen's eyes.

The weight of the aim angle, but specifically for the Citizen's head.

The weight of the aim angle, but specifically for the Citizen's body.

How much the character is rotating in degrees per second, this controls feet shuffling. If rotating clockwise this should be positive, if rotating counter-clockwise this should be negative.

The scale of being ducked (crouched) (0 - 1)

How loud are we talking?

Are we sitting down?

Are we on the ground?

Are we swimming?

Are we climbing?

Are we noclipping?

Is the weapon lowered? By default, this'll happen when the character hasn't been shooting for a while.

What kind of weapon are we holding?

What's the handedness of our weapon? Left handed, right handed, or both hands? This is only supported by some holdtypes, like Pistol, HoldItem.

Triggers a jump animation

Triggers a weapon deploy animation

We can force the model to walk or run, or let it decide based on the speed.

We can force the model to have a specific movement state, instead of just running around. is good for shimmying across a ledge. is good for a platformer game where the character is rolling around continuously. is good for a shooter game or a platformer where the character is sliding.

How are we sitting down?

How far up are we sitting down from the floor?

From 0-1, how much are we actually sitting down.

Creates a networked game lobby and assigns player prefabs to connected clients.

Create a server (if we're not joining one)

The prefab to spawn for the player to control.

A list of points to choose from randomly to spawn the player in. If not set, we'll spawn at the location of the NetworkHelper object.

A client is fully connected to the server. This is called on the host.

Find the most appropriate place to respawn

Extensions for Surfaces

Add a vertex using this position and everything else from Default

Add a vertex using this position and UV, and everything else from Default

Add a triangle to the vertex buffer. Will include indices if they're enabled.

Add a quad to the vertex buffer. Will include indices if they're enabled.

Add a cube to the vertex buffer. Will include indices if they're enabled.

A simple button .

The that displays .

The column on the right, holding the label and help

The target link, if set

Used for selection status in things like ButtonGroup

More button options underneath the main button content.

The button is disabled for some reason

Allow external factors to force the active state

Text for the button.

Help for the button.

Deletes the .

Icon for the button.

Deletes the .

Set the text for the button. Calls Text = value

Imitate the button being clicked.

A group of side-by-side buttons one of which can be selected.

Called when the value has been changed.

The selected option value.

Options to show in this button group.

CSS Class(es) to add to child buttons.

Adds a button to this group.

The button's label. Called onclick.

Adds a button to this button group with startactive and stopactive callbacks

The button's label Called on startactive with parameter of and stopactive with parameter of .

The selected button panel.

A simple checkbox .

Called when the checked state has been changed.

The checkmark icon. Although no guarantees it's an icon!

Use .

Returns true if this checkbox is checked.

The that displays .

Text for the checkbox label.

Called when changes.

Called to update visuals of the checkbox. By default this applies checked CSS class.

A panel that will navigate to an href but also have .active class if href is active

A panel that acts like a website. A single page is always visible but it will cache other views that you visit, and allow forward/backward navigation.

The currently visible panel

The Url we're currently viewing

The query part of the url

The Url we should go to when one isn't set

The panel in which we should create our pages

Called after initialization

This sucks this sucks this sucks

Instead of finding pages by attributes, we can fill them in manually here

Navigate to the passed url

Find a panel that can be created for this url

Keep pressing the back button until our url doesn't match the passed wildcard string

To back to the previous page. Return true on success.

Go forward, return true on success

Broadcast to all ancestors when the url changes

When applied to a page of a navigator, this will receive callbacks when the page is made visible and closed

Find the closest NavigationHost ancestor (or self)

Find the closest navigatorPanel ancestor and navigate to the given url

A controlsheet is a panel that you can populate with a SerializedObject's properties.

The object we're trying to display properties for.

body panel. Gets deleted and recreated on Rebuild()

Filter any properties that are added to this

Rebuild these controls. This will delete the current body panel and recreate it, then add all properties from the target object.

Called by IControlSheet logic to add a feature

Called by IControlSheet logic to add a group

Called by IControlSheet logic to filter properties.

A group for ControlSheet, consists of a title and a body containing properties.

Set the control that is going to toggle this group open and closed.

Hide this group if these attributes say so.

Used by ControlSheet to display a single row of a property. This is created from a SerializedProperty and contains a label and a control for editing the property. Controls are created using BaseControl.CreateFor.

Called whenever SerializedProperty changes to another property and we think we probably need to rebuild

Create a BaseControl for a given SerializedProperty. We'll look at BaseControls with [CustomEditor] attributes and see if any of them can handle this property.

A control for editing Color properties. Displays a text entry that can be edited, and a color swatch which pops up a mixer.

A control for picking a color using sliders and whatever

A control for editing Color properties. Displays a text entry that can be edited, and a color swatch which pops up a mixer.

A control for editing enum properties. Can either display a dropdown or a button group depending on the number of options.

Like TextEntry, except just for numbers

A that the user can enter text into.

If you hook a method up here we'll do autocomplete on it. Return a list if strings for given string input.

Open the auto complete popup with values from . Close the popup if we have no auto complete entries.

Open the auto complete popup with given values.

Close and delete the auto complete popup panel.

Auto complete selection has changed. Update the text entry text to that selected value.

Auto complete was canceled, restore text to what it was before we started, and remove the auto complete popup.

Maximum amount of items will keep. Oldest items will be discarded as new ones are added.

If set, the history of this text entry will be stored and restored using this key in the local .

Add given string to the history of this text entry. The history can be accessed by the player by pressing up and down arrows with an empty text entry.

Clear the input history that was previously added via .

The that displays

If set, will display a material icon at the end of the text entry.

If true then Icon/IconPanel will be set to a clear button that clears the text when clicked.

If set, visually signals when the input text is shorter than this value. Will also set accordingly.

If set, visually signals when the input text is longer than this value. Will also set accordingly.

If set, will block the input of any character that doesn't match. Will also set accordingly.

If set, will return true if doesn't match regex.

When set to true, ensures only numeric values can be typed. Also applies on text.

If true then this control has validation errors and the input shouldn't be accepted.

Update the validation state of this control.

Called when a character is typed by the player.

The typed character to test. Return true to allow the character to be typed.

Called when the text of this text entry is changed.

The that contains the text of this text entry.

Is the text entry disabled? If disabled, will add a "disabled" class and prevent focus.

Access to the raw text in the text entry.

The value of the text entry. Returns , but does special logic when setting text.

Whether to allow automatic replacement of emoji codes with their actual unicode emoji characters. See .

Allow IME input when this is focused.

Affects formatting of the text when is enabled. Accepts any format that is supported by . See examples here.

Makes it possible to enter new lines into the text entry. (By pressing the Enter key, which no longer acts as the submit key)

If we're numeric, this is the lowest numeric value allowed

If we're numeric, this is the highest numeric value allowed

Text to display when the text entry is empty. Typically a very short description of the expected contents or function of the text entry.

The that shows text.

If set, will display given text before the text entry box.

The that shows text.

If set, will display given text after the text entry box.

The color used for text selection highlight. Defaults to cyan with transparency.

Called when the text entry's value changes.

Keep tabs of when we were focused so we can flash the caret relative to that time. We want the caret to be visible immediately on focus

Called to ensure the is absolutely in the correct format, in this case - a valid number format.

The correctly formatted version of .

The TextEntry has the :empty style when the text is unset

Like TextEntry, except just for numbers

A UI control which provides multiple options via a dropdown box.

The icon of an arrow pointing down on the right of the element.

Called when the value has been changed,

Called just before opening, allows options to be dynamic

The options to show on click. You can edit these directly via this property.

The current string value. This is useful to have if Selected is null.

The currently selected option.

Given the type, populate options. This is useful if you're an enum type.

Open the dropdown.

Select an option.

Select an option by value string.

A field in a form, usually contains a label and a control

A panel containing an icon, typically a material icon.

Create and return an icon (panel) with given icon and optionally given CSS classes.

An option for a or .

The user-friendly text to show.

Icon for this option.

Tooltip for this option.

The internal value for this option.

Which panel triggered this popup. Set by or the constructor.

Currently selected option in the popup. Used internally for keyboard navigation.

Positioning mode for this popup.

Offset away from based on .

If true, will close this popup when the is hidden.

Dictates where a is positioned.

To the left of the source panel, centered.

To the right of the source panel, centered.

To the left of the source panel, aligned to the bottom.

To the right of the source panel, aligned to the bottom.

Above the source panel, aligned to the left.

Above the source panel, aligned to the right.

Below the source panel, aligned to the left.

Below the source panel, centered horizontally.

Below the source panel, aligned to the right.

Below the source panel, stretch to the width of the .

Above, centered

Position where the mouse cursor is currently

Sets , and . Applies relevant CSS classes.

Which panel triggered this popup. Desired positioning mode. Offset away from the .

Header panel that holds and .

Label that dispalys .

Panel that dispalys .

If set, will add an unselectable header with given text and .

If set, will add an unselectable header with given icon and .

Closes all panels, marks this one as a success and closes it.

Closes all panels, marks this one as a failure and closes it.

Add an option to this popup with given text and click action.

Add an option to this popup with given text, icon and click action.

Move selection in given direction.

Positive numbers move selection downwards, negative - upwards.

A button that opens a panel. Useless on its own - you need to implement Open

The opened .

Open a popup. You should set here.

A control that has two panes with a splitter in between. You can drag the splitter to change the size of the two panels.

The left, or top panel. Has class "split-left".

The left, or bottom panel. Has class "split-right".

The splitter control

The smallest the left section can be as a fraction (0-1). Also controls the largest the right section can be.

The smallest the right section can be as a fraction (0-1). Also controls the largest the left section can be.

Returns true if splitter is being dragged

Should this be laid out vertically? If you set this to vertical you should mentally change Left to Top and Right to Bottom.

We can save the position of this splitter in a cookie. To do that set this (or "cookie" in a template). We'll automatically save and restore from the cookie.

The splitter has been pressed

The splitter has been released

If we're dragging then position the split where the mouse is.

Sets the split fraction to this value. Will automatically adjust the value according to MinimumFraction parameters, and will save the new value to cookie.

You can create child panels in the template by setting attributes on them, like slot="left" to make that panel appear in the left panel.

Called when the card is clicked

Called when the card is right clicked

The right side of the slider.

The left side of the slider.

If set to 1, value will be rounded to 1's If set to 10, value will be rounded to 10's If set to 0.1, value will be rounded to 0.1's

Show the range values above the slider

When changing the value show the tooltip

How to display numbers in this control

Convert a screen position to a value. The value is clamped, but not snapped.

If we move the mouse while we're being pressed then set the value

On mouse press jump to that position