# winset proc

Source: https://ref.dm-lang.org/proc/winset

### Format
> `winset(player, control_id, params)`

### Args
- `player`: A mob or client.
- `control_id`: The unique ID of a control in the player's skin.
- `params`: A text string with parameters to set, in the format returned by `list2params()`; *OR* an associative list.


Sets parameters for a player's skin. The parameter list can be created by making a list and using `list2params()`, or it can be done manually by just using a string like `"is-visible=true;text-color=#f00"`. You can also just use a list directly, which will be passed to `list2params()` internally.

The `control_id` can be a window name, or in a `"[window].[control]"` format, or just the control ID as long as it is unique. In some special cases it can also be null. Another valid form is `":[type]"` which selects the default control of that type, e.g. `":map"` for the main map.

If you want to use a text string that may include spaces, surround the string with double quotes and escape them using a backslash, e.g. `"text="This is some text.""`. Backslashes can also be used by preceding them with another backslash. For filenames, use single quotes around the file. Sometimes escapement may need to go several levels deep; for example to set up an input control with a default say command, you will need to escape it twice:

>  Desired command: `say "`  
>  Escaped form with quotes: `"**say "**"`  
>  Final form: `"say ""`
>
> `winset(usr, "mainwindow.input", "command=**"say ""**")`
>
>

You can set more than one control's parameters at once by leaving the `control_id` argument null, and including the control as part of the parameter list:

```dm /winset/
winset(usr, null,\
  "mainwindow.output.background-color=#ffffff;mainwindow.input.background-color=#ffffff")
```

## Special winsets

Some "global" winset options will let you change things that affect the client as a whole, not just specific controls.

#### reset ####

You can reset the skin to its beginning state, removing all runtime-created controls and windows, by calling `winset(player, null, "reset=true")`.

#### command ####

Another use for `winset()` is to send commands to the client that normally can only run from there, like `.profile` or `.quit`. To do this, leave the `control_id` argument null, and just use a parameter called "command":

```dm /winset/
obj/quitbutton
    name = "Quit"
    icon = 'buttons.dmi'
    icon_state = "quit"

    Click()
        winset(usr, null, list("command"=".quit"))
```

Because many characters need to be specially encoded for winsets, it's best to either use the list format of `winset()` which handles that encoding for you. If you want to use the string form, like `winset(usr, null, "command=XYZ")`, then you should use [url_encode()](https://ref.dm-lang.org/proc/url_encode.md) to encode your command.

#### browser-options ####

The "browser-options" global parameter lets you enable or disable certain browser functionality. This can be a comma-separated list, or you can precede an option with `+` or `-` to enable or disable it specifically.

|   Option   |Default|                              Description                               |
|------------|-------|------------------------------------------------------------------------|
|    find    |   ❌   |               Ctrl+F can open the built-in Find dialog.                |
|  devtools  |   ❌   | F12 can open a devtools window, which is useful for debugging scripts. |
|  refresh   |   ❌   |                   Ctrl+R or F5 can refresh the page.                   |
|    zoom    |   ❌   |Ctrl with the + or - keys can zoom the browser, and Ctrl+0 can reset it.|
|byondstorage|   ❌   |   Enables [byondStorage](https://ref.dm-lang.org/skin/control/browser/byondStorage.md) access.   |

```dm /winset/
mob/Login()
    ..()
    winset(usr, null, "browser-options=devtools,find")
```

If you plan to use the `+` or `-` modifiers, you should either use the list format of `winset()` or use [url_encode()](https://ref.dm-lang.org/proc/url_encode.md) to encode the list of options.

Browser options are shared across all browser controls.

### See also
- [winclone proc](https://ref.dm-lang.org/proc/winclone.md)
- [winexists proc](https://ref.dm-lang.org/proc/winexists.md)
- [winget proc](https://ref.dm-lang.org/proc/winget.md)
- [winshow proc](https://ref.dm-lang.org/proc/winshow.md)
- [User interface skins](https://ref.dm-lang.org/skin/index.md)
- [parameters (skin)](https://ref.dm-lang.org/skin/param/index.md)