Overwatch Workshop

https://workshop.codes/wiki
Admin
Overwatch Workshop is a game scripting system that allows players to create custom game modes and...
Tokens:1,534,559
Snippets:12,252
Trust Score:9.1
Update:10 months ago
Show doc for...
Tokens:
Raw
### Markdown Links Example

Source: https://workshop.codes/wiki/edits/849

Provides examples of different link syntaxes: inline-style links with and without titles, reference-style links, relative links, and automatic URL detection. Also covers link definitions.

```markdown
[I'm an inline-style link](https://www.google.com)

[I'm an inline-style link with title](https://www.google.com "Google's Homepage")

[I'm a reference-style link][Arbitrary case-insensitive reference text]

[I'm a relative reference to a repository file](../blob/master/LICENSE)

[You can use numbers for reference-style link definitions][1]

Or leave it empty and use the [link text itself].

URLs and URLs in angle brackets will automatically get turned into links. <http://www.example.com> or http://www.example.com.

Some text to show that the reference links can follow later.

[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com
```

--------------------------------

### Markdown Links

Source: https://workshop.codes/wiki/edits/2002

Provides examples of creating inline-style links with and without titles, and demonstrates linking by simply using the URL. Input and output are shown.

```markdown
[I'm an inline-style link](https://www.google.com)
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")
Or leave it empty and use the simply use the link itself https://www.google.com.
```

--------------------------------

### Start Game Mode

Source: https://workshop.codes/wiki/articles/is-firing-primary

Initiates the start of the game mode, often triggering the beginning of the match timer and player spawns. This action is typically used to transition from a setup phase to active gameplay. No parameters are required.

```Workshop
Start Game Mode()
```

--------------------------------

### Markdown Links Example

Source: https://workshop.codes/wiki/edits/1585

Provides examples of creating inline and reference-style links, including links with titles and relative links. It also covers automatic URL conversion and the handling of empty reference definitions.

```markdown
[I'm an inline-style link](https://www.google.com)
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")
[I'm a reference-style link][Arbitrary case-insensitive reference text]
[I'm a relative reference to a repository file](../blob/master/LICENSE)
[You can use numbers for reference-style link definitions][1]
Or leave it empty and use the [link text itself].

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or <http://www.example.com>.

Some text to show that the reference links can follow later.

[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com
```

--------------------------------

### Workshop Setting Combo Example

Source: https://workshop.codes/wiki/edits/1225

Demonstrates how to create a Workshop Setting Combo, which allows the lobby host to select a string from a predefined list. The selected option is communicated to the Workshop mode as an index, starting from 0.

```Workshop
Global.A = Workshop Setting Combo(Custom String("Category Name Here"), Custom String("Combo"), 0, Array(Custom String("Option 1"),
Custom String("Option 2"), Custom String("Option 3")), 0);
```

--------------------------------

### Fenced Code Blocks - Workshop.codes Rule

Source: https://workshop.codes/wiki/edits/2002

Demonstrates the syntax for creating fenced code blocks, which are recommended for readability and syntax highlighting. This example shows a basic rule structure.

```Workshop.codes
rule("Each Player Rule") {
  event {
    Player Dealt Damage;
    All;
    All;
  }
  conditions {
  }
  actions {
    Small Message(All Players(All Teams), Custom String("Dealt damage"));
  }
}
```

--------------------------------

### Workshop Data Compression Initialization and Example

Source: https://workshop.codes/wiki/edits/5139

Initializes variables for data compression, including a mapping for numbers, an array of colors, and compressed data strings. It then calls a subroutine to decompress this data and stores it in the 'doors' variable. This demonstrates the setup and execution of the compression process.

```Workshop
rule("Example data to compress")
{
  event
  {
    Ongoing - Global;
  }
  actions
  {
    Global.numbers = Custom String("0123456789ABCDEF");
    Global.colors = Array(Color(White), Color(Yellow), Color(Green), Color(Purple), Color(Red), Color(Blue), Color(Aqua), Color(
    Orange), Color(Sky Blue), Color(Turquoise), Color(Lime Green), Color(Gray), Color(Violet), Color(Rose), Color(Black));
    Global.compressedData = Custom String(
    "$Door A,v100,90.2,-80.3,c7,7.6,$Door B,v110,151.2,-60.3,c2,7.0,$Dangerous Door of Death and Doom,v190,40.2,110.3,cF,3.0,$Secr{0}",
    Custom String("et Door,v83.2,45.2,19.6,c0,2.8"));
    Call Subroutine(DecompressString);
    Global.doors = Global.decompressed;
  }
}
```

--------------------------------

### Markdown Images

Source: https://workshop.codes/wiki/edits/848

Demonstrates how to embed images using both inline-style and reference-style syntax. Includes examples for 'alt text' and title text, essential for accessibility and image descriptions.

```markdown
Here's an image (hover to see the title text):

Inline-style: 
![alt text](https://d1u1mce87gyfbn.cloudfront.net/game/rank-icons/rank-GrandmasterTier.png "Logo Title Text 1")

Reference-style: 
![alt text][logo]
```

--------------------------------

### Markdown Lists Example (Ordered and Unordered)

Source: https://workshop.codes/wiki/edits/851

Shows how to create ordered lists using numbers followed by periods, and unordered lists using asterisks (*), hyphens (-), or pluses (+). Includes examples of sub-lists and indented paragraphs within list items.

```markdown
1. First ordered list item
2. Another item
  * Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
4. And another item.

  You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
  To have a line break without a paragraph, you will need to use two trailing spaces.  
Note that this line is separate, but within the same paragraph. 
(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses
```

--------------------------------

### Markdown Image Syntax Examples

Source: https://workshop.codes/wiki/edits/1303

Demonstrates both inline-style and reference-style syntax for including images in Markdown. Ensure the image URLs are valid and accessible.

```markdown
![alt text](https://d1u1mce87gyfbn.cloudfront.net/game/rank-icons/rank-GrandmasterTier.png "Logo Title Text 1")
![alt text][logo]
[logo]: https://d1u1mce87gyfbn.cloudfront.net/game/rank-icons/rank-GrandmasterTier.png "Logo Title Text 2"
```

--------------------------------

### Markdown Headers Example

Source: https://workshop.codes/wiki/edits/851

Demonstrates how to create different levels of headers using hash symbols (#) or underlines with equals (=) or hyphens (-) for H1 and H2. Supports up to H6.

```markdown
# H1
## H2
### H3
#### H4
##### H5
###### H6

Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
========

Alt-H2
------
```

--------------------------------

### Start Camera

Source: https://workshop.codes/wiki/articles/is-firing-primary

Initiates a camera effect or transition for a player. This can be used to create cinematic moments, focus on specific events, or guide player attention. Requires the player and camera settings.

```Workshop
Start Camera(Event Player, "Follow", Event Player)
```

--------------------------------

### Start Assist Action

Source: https://workshop.codes/wiki/articles/start%2Bassist

Starts granting assist credit towards Assisters when Targets are eliminated. This action can fail if too many assists have been started.

```APIDOC
## POST /actions/start_assist

### Description
Starts granting assist credit towards one or more Assisters when one or more Targets are eliminated. A reference to this damage modification can be obtained from the Last Assist ID value. This Action will fail if too many assists have been started.

### Method
POST

### Endpoint
/actions/start_assist

### Parameters
#### Request Body
- **Assisters** (Player | Array<Player>) - Optional - The target Player or Players who will receive assist credit. Defaults to Event Player.
- **Targets** (Player | Array<Player>) - Optional - The Player or Players whose eliminations will grant assist credit to the Assisters. If the Target or Targets are allied to the Assister, this will be a defensive assist. Otherwise, this will be an offensive assist. Defaults to All Players.
- **Reevaluation** (Chase Reevaluation) - Optional - Specifies which of this Action's Inputs will be continuously reevaluated. This Action will keep asking for and using new Values from reevaluated Inputs. Defaults to Assisters and Targets.

### Request Example
```json
{
  "Assisters": "Event Player",
  "Targets": "All Players(All Teams)",
  "Reevaluation": "Assisters and Targets"
}
```

### Response
#### Success Response (200)
This action returns Void, indicating success or failure based on context (e.g., too many assists started).

#### Response Example
(No JSON response body for Void return type)
```

--------------------------------

### Markdown Links Example

Source: https://workshop.codes/wiki/edits/1303

Demonstrates various methods for creating links in Markdown, including inline styles, reference styles, and automatic URL conversion. Covers relative links and custom reference text.

```markdown
[I'm an inline-style link](https://www.google.com)
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")
[I'm a reference-style link][Arbitrary case-insensitive reference text]
[I'm a relative reference to a repository file](../blob/master/LICENSE)
[You can use numbers for reference-style link definitions][1]
Or leave it empty and use the [link text itself].

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or <http://www.example.com>.

Some text to show that the reference links can follow later.
[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com
```

--------------------------------

### Python Syntax Highlighting Example

Source: https://workshop.codes/wiki/edits/1303

This snippet demonstrates fenced code blocks for Python syntax highlighting. It assigns a string to a variable and prints it.

```markdown
```python
s = "Python syntax highlighting"
print s
```
```

--------------------------------

### Markdown Links Syntax (Inline and Reference)

Source: https://workshop.codes/wiki/edits/849

Details how to create inline and reference-style links. Includes examples of links with titles, relative links to repository files, and automatic URL conversion. Reference-style links can be defined separately.

```markdown
[I'm an inline-style link](https://www.google.com)

[I'm an inline-style link with title](https://www.google.com "Google's Homepage")

[I'm a reference-style link][Arbitrary case-insensitive reference text]
[I'm a relative reference to a repository file](../blob/master/LICENSE)
[You can use numbers for reference-style link definitions][1]
Or leave it empty and use the [link text itself].

URLs and URLs in angle brackets will automatically get turned into links.
http://www.example.com or <http://www.example.com>.

Some text to show that the reference links can follow later.
[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com
```

--------------------------------

### Prevent Waitless Loops with Wait Actions in Custom Games

Source: https://workshop.codes/wiki/articles/help-my-server-is-crashing-a-guide-on-how-to-improve-server-stability-for-your-codes

Demonstrates how to prevent server crashes caused by waitless loops by introducing a 'Wait' action. This example shows a basic loop structure and how to implement a delay to reduce server load.

```Custom Game Script
For Global Variable(A, 0, 100, 1);
  Small Message(All Players(All Teams), Custom String("I'm looping!"));
End;
```

```Custom Game Script
rule("Looping")
{
  conditions
    {
    Is Button Held(Event Player, Button(Interact)) == True;
  }

  actions
    {
    Small Message(All Players(All Teams), Custom String("I'm looping!"));
    Loop If Condition Is True;
  }
}
```

```Custom Game Script
< Your actions >

Global.batch++
if Global.batch == 20
  Wait(0.016)
  Global.batch == 0
end

```

--------------------------------

### Markdown Lists Example

Source: https://workshop.codes/wiki/edits/1303

Shows the syntax for creating ordered and unordered lists, including nested lists and custom line breaks within list items. Notes differences in line break handling compared to GFM.

```markdown
1. First ordered list item
2. Another item
  * Unordered sub-list.
  1. Ordered sub-list
4. And another item.

  You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

  To have a line break without a paragraph, you will need to use two trailing spaces.  
Note that this line is separate, but within the same paragraph.  
(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses
```

--------------------------------

### Markdown Lists Example

Source: https://workshop.codes/wiki/edits/849

Shows how to create ordered and unordered lists, including sub-lists and indented paragraphs within list items. Demonstrates variations for unordered lists (asterisks, minuses, pluses) and specific line break handling.

```markdown
1. First ordered list item
2. Another item
  * Unordered sub-list. 
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
4. And another item.
  
  You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
  To have a line break without a paragraph, you will need to use two trailing spaces.  
Note that this line is separate, but within the same paragraph.  
(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses
```

--------------------------------

### Start Forcing Spawn Room Action

Source: https://workshop.codes/wiki/edits/4449

This section details the 'Start Forcing Spawn Room' action, which forces a team to spawn in a particular spawn room. It specifies the arguments required, their types, and their descriptions.

```APIDOC
## POST /wiki/actions/start-forcing-spawn-room

### Description
Forces a team to spawn in a particular spawn room, regardless of the spawn room normally used by the game mode. This action only has an effect in assault, hybrid, and payload maps.

### Method
POST

### Endpoint
/wiki/actions/start-forcing-spawn-room

### Parameters
#### Request Body
- **Team** (Team) - Required - The team whose spawn room will be forced.
- **Room** (Integer) - Required - The number of the spawn room to be forced. 0 is the first spawn room, 1 the second, and 2 is the third. If the specified spawn room does not exist, players will use the normal spawn room.

### Request Example
```json
{
  "Team": "Team 1",
  "Room": 0
}
```

### Response
#### Success Response (200)
- **Void** - This action does not return any value.

#### Response Example
```json
// No response body for void return type
```
```

--------------------------------

### Markdown Lists (Ordered and Unordered)

Source: https://workshop.codes/wiki/edits/852

Shows how to create ordered lists using numbers and unordered lists using asterisks, hyphens, or plus signs. Includes examples of sub-lists and indented paragraphs within list items.

```markdown
1. First ordered list item
2. Another item
  * Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
4. And another item.

  You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

  To have a line break without a paragraph, you will need to use two trailing spaces.  
Note that this line is separate, but within the same paragraph. 
(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses
```

--------------------------------

### Optimize Condition Checking Order in Custom Game Rules

Source: https://workshop.codes/wiki/articles/help-my-server-is-crashing-a-guide-on-how-to-improve-server-stability-for-your-codes

Illustrates the sequential nature of condition checking in custom game rules. This example shows how the order of conditions can affect execution, ensuring that less frequent or more computationally expensive checks are placed later.

```Custom Game Script
rule("My Rule")
{

    event
    {
        Ongoing - Each Player;
        All;
        All;
    }

    conditions
    {
        Is Button Held(Event Player, Button(Interact)) == True;
        Is Alive(Event Player) == True;
    }
}
```

--------------------------------

### Start Camera Action

Source: https://workshop.codes/wiki/edits/7185

The Start Camera action allows you to programmatically control a player's camera, setting its position and the direction it faces.

```APIDOC
## POST /wiki/actions/start-camera

### Description
Places your camera at a location, facing a direction.

### Method
POST

### Endpoint
/wiki/actions/start-camera

### Parameters
#### Request Body
- **player** (Player | Array<Player>) - Required - The player or players whose cameras will be placed at the location. Defaults to Event Player.
- **eyePosition** (Position) - Required - The position of the camera. Reevaluates continuously. Defaults to Vector(0, 0, 0).
- **lookAtPosition** (Position) - Required - Where the camera looks at. Reevaluates continuously. Defaults to Vector(0, 0, 0).
- **blendSpeed** (Float) - Optional - How fast to blend the camera speed as positions change. 0 means do not blend at all, and just change positions instantly. Defaults to 0.

### Request Example
```json
{
  "player": "Event Player",
  "eyePosition": {
    "x": 100,
    "y": 50,
    "z": 200
  },
  "lookAtPosition": {
    "x": 0,
    "y": 0,
    "z": 0
  },
  "blendSpeed": 1.0
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```

### Notes
Evaluate Once does not work on the parameters of this action. Instead, store the *eye position* and *look at position* in a separate global/player variable that is not used for anything else.
```

--------------------------------

### Game Initialization and Setup

Source: https://workshop.codes/wiki/articles/random%2Breal

Actions used to set up and initialize game elements, including preloading heroes, creating effects, and enabling/disabling various game mode features.

```plain_text
Preload Hero
Create Effect
Create HUD Text
Create Icon
Create In-World Text
Create Progress Bar HUD Text
Create Progress Bar In-World Text
Enable Built-In Game Mode Announcer
Enable Built-In Game Mode Completion
Enable Built-In Game Mode Music
Enable Built-In Game Mode Respawning
Enable Built-In Game Mode Scoring
```

--------------------------------

### @for Directive Syntax and Examples

Source: https://workshop.codes/wiki/edits/1893

Explains the syntax for the @for directive, which allows for iterative loops. It supports exclusive (start to end-1) and inclusive (start to end) ranges, with an optional control variable defaulting to 'i'. An example shows a countdown loop rendering messages.

```workshop.codes
// Exclusive: current will go form start to end - 1 (excluding end)
@for (current from start to end) {
  Current value: For.current
}

// Inclusive: current will go form start to end (including end)
@for (current from start through end) {
  Current value: For.current
}

// Control variable defaults to `i`.
// The "for" is also optional.
@for (start to end) {
  Current value: For.i
}

// Example:
@for (countdown from 10 through 1) {
  Small Message(For.countdown);
  Wait(1, Ignore Condition);
}
```

--------------------------------

### Get Assist Count (Workshop)

Source: https://workshop.codes/wiki/articles/assist%2Bcount

Retrieves the current number of Assist instances that have been started by the 'Start Assist Action'. This value is an integer and does not require any parameters.

```Workshop
Assist Count;
```

--------------------------------

### Actions: Player Initialization and Setup

Source: https://workshop.codes/wiki/articles/array-slice

Actions used to set up players at the beginning of a match or round. Includes resetting heroes, setting spawn points, and assigning teams.

```N/A
Reset Player Hero Availability
Move Player To Team
Start Forcing Spawn Room
```

--------------------------------

### Start Forcing Dummy Bot Name

Source: https://workshop.codes/wiki/articles/start%2Bforcing%2Bdummy%2Bbot%2Bname

Starts forcing the name for the specified Player or Players. Ensure the dummy bot has spawned before assigning a name.

```APIDOC
## Start Forcing Dummy Bot Name

### Description
Starts forcing the name for the specified Player or Players. Make sure the dummy bot has had time to spawn before giving them their name.

### Method
Custom Action

### Endpoint
N/A (Custom Action)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
Start Forcing Dummy Bot Name(Event Player, Custom String("Dummy Bot Name"));
```

### Response
#### Success Response (Void)
This action does not return a value.

#### Response Example
N/A

### Properties
**Returns**: Void
**Parameters**:
- **Player** (Type: Player, Default: Event Player) - The Player whose name will be forced.
- **Name** (Type: String, Default: Custom String("")) - The name to be forced.
```

--------------------------------

### Get Flag Position - Workshop.codes (Example)

Source: https://workshop.codes/wiki/edits/4611

This snippet demonstrates how to get the position of a specific team's flag in the game. It requires a 'Team' object as input and returns a 'Vector' representing the flag's position. Ensure the 'Team' type is correctly defined and instantiated.

```workshop.codes
Flag Position(Team(Team 1));
```

--------------------------------

### Workshop: Data Compression Initialization

Source: https://workshop.codes/wiki/edits/5931

This code initializes global variables, including numbers, colors, and the compressed data. It then calls the Dec**ompressString** subroutine to process the compressed data and stores the result in the doors variable. The code involves splitting, parsing and applying the corresponding values.

```Workshop
Global.numbers = Custom String("0123456789ABCDEF");
Global.colors = Array(Color(White), Color(Yellow), Color(Green), Color(Purple), Color(Red), Color(Blue), Color(Aqua), Color(Orange), Color(Sky Blue), Color(Turquoise), Color(Lime Green), Color(Gray), Color(Violet), Color(Rose), Color(Black));
Global.compressedData = Custom String("$Door A,v100,90.2,-80.3,c7,7.6,$Door B,v110,151.2,-60.3,c2,7.0,$Dangerous Door of Death and Doom,v190,40.2,110.3,cF,3.0,$Secret Door,v83.2,45.2,19.6,c0,2.8");
Call Subroutine(Dec**ompressString**);
Global.doors = Global.decompressed;
```

--------------------------------

### Markdown Lists: Ordered and Unordered

Source: https://workshop.codes/wiki/edits/1585

Provides examples for creating ordered lists using numbers and unordered lists using asterisks, minuses, or pluses. It includes examples of sub-lists and indented paragraphs within list items, noting specific line break behavior.

```markdown
1. First ordered list item
2. Another item
   * Unordered sub-list.
   1. Ordered sub-list
4. And another item.

   You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

   To have a line break without a paragraph, you will need to use two trailing spaces.  
Note that this line is separate, but within the same paragraph.  
(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses
```

--------------------------------

### Define and Use Mixins with Parameters

Source: https://workshop.codes/wiki/edits/1804

Demonstrates defining a mixin with parameters and calling it. The example shows how to multiply a variable by a given multiplier. The compiled output shows the direct code replacement.

```Workshop.codes
@mixin multiplyValue(variable, multiplier)
{
Mixin.variable = 2 * Mixin.multiplier;
}

rule("Some Rule")
{
...
 actions
{
@include multiplyValue(Global.someVar, 5);
@include multiplyValue(Global.someOtherVar, 10);
}
}
```

```Workshop.codes
rule("Some Rule")
{
...
 actions
{
Global.someVar = 2 * 5;
Global.someOtherVar = 2 * 10;
}
}
```

--------------------------------

### Complete Rule Structure Example

Source: https://workshop.codes/wiki/edits/4848

Provides a complete example of a Workshop rule, including event triggers, conditions for button press and effect removal, and actions for creating and managing effects.

```Workshop
rule("Create effect")
{
  event
  {
    Ongoing - Each Player;
    All;
    All;
  }
  
  conditions
  {
    Is Button Held(Event Player, Interact) == True;
    Count Of(Event Player.Effects) == 0;
  }
  
  actions
  {
    Event Player.Effects = Empty Array;
    Create Effect(All Players(All Teams), Cloud, White, Event Player, 1, Visible To Position and Radius);
  }
}
```

--------------------------------

### Get Wiki Article Details

Source: https://workshop.codes/wiki/edits/4447

Retrieves detailed information about a specific wiki article, including its content, properties, and metadata.

```APIDOC
## GET /api/wiki/articles/{slug}

### Description
Retrieves detailed information for a specific wiki article using its slug.

### Method
GET

### Endpoint
/api/wiki/articles/{slug}

### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique slug identifier for the wiki article.

### Request Example
```
GET /api/wiki/articles/start-forcing-player-to-be-hero
```

### Response
#### Success Response (200)
- **title** (string) - The title of the wiki article.
- **slug** (string) - The slug of the wiki article.
- **content** (string) - The main content of the wiki article, potentially including markdown and code snippets.
- **category** (string) - The category of the wiki article.
- **tags** (array of strings) - Tags associated with the wiki article.
- **properties** (object) - Specific properties related to the article's functionality (e.g., for actions).
  - **returns** (string) - The return type of the function/action described.
  - **parameters** (array of objects) - Details about the parameters the function/action accepts.
    - **name** (string) - The name of the parameter.
    - **type** (string) - The data type of the parameter.
    - **description** (string) - A description of the parameter.
    - **defaultValue** (string) - The default value of the parameter, if any.

#### Response Example
```json
{
  "title": "Start Forcing Player To Be Hero",
  "slug": "start-forcing-player-to-be-hero",
  "content": "## Description\n\nStarts forcing one or more players to be a specific hero and, if necessary, respawns them immediately in their current location. This will be the only hero available to the player or players until the [Stop Forcing Player To Be Hero](https://workshop.codes/wiki/articles/stop%2Bforcing%2Bplayer%2Bto%2Bbe%2Bhero) action is executed.\n\n## Snippet\n\n```\nStart Forcing Player To Be Hero(Event Player, Hero(Tracer));\n```\n\n## Properties\n\nReturns: _ <span style=\"color: #c678dd\">Void</span>_\nParameters: ==_Player_==, ==_Hero_==",
  "category": "Actions",
  "tags": [
    "Start Forcing Player To Be Hero",
    "Comenzar a forzar a un jugador a usar un héroe",
    "Forcer un héros",
    "プレイヤーへのヒーロー強制を開始",
    "Começar a Forçar Jogador a Ser o Herói",
    "开始强制玩家选择英雄"
  ],
  "properties": {
    "returns": "Void",
    "parameters": [
      {
        "name": "Player",
        "type": "Player | Array<Player>",
        "description": "The player or players who will be forced to be a specific hero.",
        "defaultValue": "Event Player"
      },
      {
        "name": "Hero",
        "type": "Hero",
        "description": "The hero that the player or players will be forced to be.",
        "defaultValue": "Hero"
      }
    ]
  }
}
```
```

--------------------------------

### Call Subroutine Action and Examples

Source: https://workshop.codes/wiki/articles/call-subroutine

Demonstrates the 'Call Subroutine' action to execute a subroutine rule. Includes examples of simple and nested subroutine calls, highlighting code reusability and conciseness in Workshop.codes.

```Workshop.codes
Call Subroutine(SubroutineName);

subroutines
{
    0: modifyVariables
}

rule("pressing crouch")
{
    event
    {
        Ongoing - Each Player;
        All;
        All;
    }

    conditions
    {
        Is Button Held(Event Player, Button(Crouch)) == True;
    }

    actions
    {
        Call Subroutine(modifyVariables);
    }
}

rule("pressing Jump")
{
    event
    {
        Ongoing - Each Player;
        All;
        All;
    }

    conditions
    {
        Is Button Held(Event Player, Button(Jump)) == True;
    }

    actions
    {
        Call Subroutine(modifyVariables);
    }
}

rule("A very long subroutine")
{
    event
    {
        Subroutine;
        modifyVariables;
    }

    actions
    {
        Global.A += 1;
        Global.B += 1;
        Global.C[0] += 1;
        Event Player.A += 1;
        Event Player.B[0] += 1;
    }
}

subroutines
{
    0: NestedSubroutine
    1: IncramentVariables
}

rule("call subroutine on jump")
{
    event
    {
        Ongoing - Each Player;
        All;
        All;
    }

    conditions
    {
        Is Button Held(Event Player, Button(Jump)) == True;
    }

    actions
    {
        Call Subroutine(NestedSubroutine);
    }
}

rule("call subroutine on crouch")
{
    event
    {
        Ongoing - Each Player;
        All;
        All;
    }

    conditions
    {
        Is Button Held(Event Player, Button(Crouch)) == True;
    }

    actions
    {
        Call Subroutine(NestedSubroutine);
    }
}

rule("Set facing - subroutine")
{
    event
    {
        Subroutine;
        NestedSubroutine;
    }

    actions
    {
        Set Facing(Event Player, Vector(0, 0, 0), To World);
        Wait(0.250, Ignore Condition);
        Call Subroutine(IncramentVariables);
        Wait(0.250, Ignore Condition);
        Call Subroutine(IncramentVariables);
        Wait(0.250, Ignore Condition);
        Call Subroutine(IncramentVariables);
    }
}

rule("change variables by 1 - Subroutine")
{
    event
    {
        Subroutine;
        IncramentVariables;
    }

    actions
    {
        Global.A += 1;
        Global.B += 1;
        Global.C[0] += 1;
        Event Player.A += 1;
        Event Player.B[0] += 1;
    }
}
```

--------------------------------

### Get Wiki Article Details

Source: https://workshop.codes/wiki/edits/4550

Retrieve the full details of a specific wiki article using its slug. This includes descriptions, properties, and code examples.

```APIDOC
## GET /websites/workshop_codes_wiki/{slug}

### Description
Fetches the detailed content of a specific wiki article, identified by its unique slug. This includes descriptions, return values, parameters, and code snippets.

### Method
GET

### Endpoint
/websites/workshop_codes_wiki/{slug}

### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier (slug) of the wiki article to retrieve.

### Request Example
(No explicit request body for GET requests, parameters are in the URL)

### Response
#### Success Response (200)
- **title** (string) - The title of the wiki article.
- **slug** (string) - The unique slug of the wiki article.
- **content** (string) - The main content of the article, often including markdown and code examples.
- **category** (string) - The category the article belongs to.
- **tags** (array) - A list of tags associated with the article.

#### Response Example
```json
{
  "title": "All Dead Players",
  "slug": "all-dead-players",
  "content": "## Description\n* <big>An array containing all dead players on a team or in the match.</big>\n* **## Snippet**\n****\n* **```**\n* **All Dead Players(Team(Team 1));**\n* **```**\n****\n* **## Properties**\n****\n****Returns**: _ <span style=\"color: #c678dd\"**>**Array </span> (<span style=\"color: #c678dd\">Player</span>)_**\n****Parameters** **: **==_Team_==**\n****\n* **> ==**Team**==**\n* **> _Type: **[Team](/wiki/articles/team)**, Default: **Team**_**\n* **> **The team or teams from which players may come.",
  "category": "Values",
  "tags": [
    "All Dead Players",
    "Todos los jugadores muertos",
    "Tous les joueurs morts",
    "倒れたプレイヤー全員",
    "Todos os Jogadores Mortos",
    "所有死亡玩家"
  ]
}
```
```

--------------------------------

### Workshop Settings Implementation Example (Overwatch Workshop)

Source: https://workshop.codes/wiki/articles/how%2Bto%2Buse%2Bworkshop%2Bsettings

This code snippet demonstrates the implementation of various Workshop Settings within an Overwatch Workshop rule. It shows how to define Combo, Hero, Integer, Real, and Toggle settings, assigning them to global variables for use in the game mode. Note that 'Category Name Here' and specific options should be customized for your mode.

```Overwatch Workshop
rule("Rule 1")
{
    event
    {
        Ongoing - Global;
    }

    actions
    {
        Global.A = Workshop Setting Combo(Custom String("Category Name Here"), Custom String("Combo"), 0, Array(Custom String("Option 1"),
            Custom String("Option 2"), Custom String("Option 3")), 0);
        Global.B = Workshop Setting Hero(Custom String("Category Name Here"), Custom String("Hero"), Ana, 0);
        Global.C = Workshop Setting Integer(Custom String("Category Name Here"), Custom String("Integer"), 0, 0, 100, 0);
        Global.D = Workshop Setting Real(Custom String("Category Name Here"), Custom String("Real"), 0, 0, 100, 0);
        Global.E = Workshop Setting Toggle(Custom String("Category Name Here"), Custom String("Toggle"), False, 0);
    }
}
```

--------------------------------

### Get Wiki Article Details

Source: https://workshop.codes/wiki/edits/4728

Retrieve detailed information about a specific wiki article, including its content, properties, and usage examples.

```APIDOC
## GET /websites/workshop_codes_wiki/{slug}

### Description
Fetches the complete details of a specific wiki article using its unique slug.

### Method
GET

### Endpoint
/websites/workshop_codes_wiki/{slug}

### Path Parameters
- **slug** (string) - Required - The unique identifier (slug) of the wiki article.

### Request Example
```
GET /websites/workshop_codes_wiki/ray-cast-hit-player
```

### Response
#### Success Response (200)
- **title** (string) - The title of the wiki article.
- **slug** (string) - The unique slug of the wiki article.
- **content** (string) - The detailed content of the wiki article, including descriptions, parameters, and examples.
- **category** (string) - The category the article belongs to.
- **tags** (array of strings) - Tags associated with the article.

#### Response Example
```json
{
  "title": "Ray Cast Hit Player",
  "slug": "ray-cast-hit-player",
  "content": "## Description****\n****\n****The player hit by the ray cast (or null if no player is hit). Ray casts ignore players with \"Phased Out\" status.\n  * ==_For a more in-depth guide on ray casts, check out [Ray casts and You](https:\/\/workshop.codes\/wiki\/articles\/ray+casts+and+you)_==****\n****\n**## Snippet**\n****\n**```**\n**Ray Cast Hit Player(Vector(0, 0, 0), Vector(0, 0, 0), All P**layer**s(All Teams), Event Player, True);**\n**```**\n****\n**## Properties**\n****\n****Returns**: _ <span style=\"color: #c678dd\">Player</span>_**\n**Parameters** **: **==_Start Pos_==, ==_End Pos_==, ==_Players To Include_==, ==_Players To Exclude_==, ==_Include Player Owned Objects_==**\n**\n**> ==**Start Pos**==**\n**> _Type: **Position**, Default: **[Vector](/wiki/articles/vector)**_**\n**>** The start position for the ray cast. If a player is provided, a position 2 meters above the player's feet is used.****\n**\n**> ==**End Pos**==**\n**> _**Type**: **** Position****,** Default**: **[Vector](/wiki/articles/vector)**_**\n**>** The end position for the ray cast. If a player is provided, a position 2 meters above the player's feet is used.****\n**\n**> ==**Players To Include**==**\n**> _Type: **Array** (**Player**), Default: **[All Players](/wiki/articles/all-players)**_**\n**>** Which players can be hit by this ray cast.****\n**\n**> ==**Players To Exclude**==**\n**> _Type: ****Array**** (**** Player****),** Default**: **[Event Player](/wiki/articles/event-player)**_**\n**>** Which players cannot be hit by this ray cast. This list takes precedence over players to include.****\n**\n**> ==**Include** Player**Owned Objects**==**\n**> _Type: **Boolean**, Default: **[True](/wiki/articles/true)**_**\n**>** Whether player-owned objects (such as barriers or turrets) should be included in the ray cast.",
  "category": "Values",
  "tags": [
    "Ray Cast Hit Player",
    "Jugador de impacto de lanzamiento de rayo",
    "Joueur intersecté par le rayon émis",
    "レイ・キャストが当たったプレイヤー",
    "Jogador Atingido pelo Lançamento de Raio",
    "射线命中玩家"
  ]
}
```
```

--------------------------------

### Get Wiki Article Content

Source: https://workshop.codes/wiki/edits/4448

Retrieves the detailed content of a specific wiki article, including its title, slug, content, category, and tags.

```APIDOC
## GET /websites/workshop_codes_wiki/{slug}

### Description
Retrieves the full content and metadata for a specific wiki article identified by its slug.

### Method
GET

### Endpoint
/websites/workshop_codes_wiki/{slug}

### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique slug of the wiki article to retrieve.

### Request Example
```
GET /websites/workshop_codes_wiki/start-forcing-player-position
```

### Response
#### Success Response (200)
- **title** (string) - The title of the wiki article.
- **slug** (string) - The unique slug of the wiki article.
- **content** (string) - The main content of the wiki article, including markdown formatting.
- **category** (string) - The category the article belongs to.
- **tags** (array of strings) - Tags associated with the article.

#### Response Example
```json
{
  "title": "Start Forcing Player Position",
  "slug": "start-forcing-player-position",
  "content": "## Description\n****\n****Starts forcing a player to be in a given position. IF reevaluation is enabled, then the position is evaluated every frame, allowing the player to be moved around over time.\n****\n**## Snippet**\n****\n**```**\n**Start Forcing Player Position(Event Player, Vector(0, 0, 0), True);**\n**```**\n****\n**## Properties**\n****\n**Returns**: _ <span style=\"color: #c678dd\">Void</span>_**\n**Parameters** **: **==_Player_==, ==_Position_==, ==_REEVALUATE_==**\n****\n**> ==**Player**==**\n**> _Type: **[Player](/wiki/articles/player)**, Default: **[Event Player](/wiki/articles/event+player)**_**\n**>** The player whose position will be forced. (The reevaluation option does not apply to this value.)\n****\n**> ==**Position**==**\n**> _**Type**: **Position**,** Default**: **[Vector](/wiki/articles/vector)**_**\n**>** The position the player will occupy. If reevaluation is enabled, this value can be used to move the player around over time.\n****\n**> ==**REEVALUATE**==**\n**> _**Type**: **Boolean**,** Default**: **[True](/wiki/articles/true)**_**\n**>** If this value is true, then the position will be reevaluated and applied to the player every frame. If this value is false, then the posiiton is only evaluated once when the action begins.",
  "category": "Actions",
  "tags": [
    "Start Forcing Player Position",
    "Comenzar a forzar la posición del jugador",
    "Forcer la position du joueur",
    "プレイヤーの位置強制を開始",
    "Começar a Forçar Posição do Jogador",
    "开始强制设置玩家位置"
  ]
}
```
```

--------------------------------

### Workshop Setting Hero Example

Source: https://workshop.codes/wiki/edits/1225

Shows how to implement a Workshop Setting Hero, enabling the lobby host to choose a hero from the available roster. This setting evaluates to a hero value, similar to the standard Hero value in Workshop.

```Workshop
Global.B = Workshop Setting Hero(Custom String("Category Name Here"), Custom String("Hero"), Ana, 0);
```

--------------------------------

### Start Rule Action - Workshop.codes

Source: https://workshop.codes/wiki/articles/start%2Brule

Initiates the simultaneous execution of a Subroutine rule. The original rule's execution is unaffected, and the subroutine inherits the same contextual values. It requires the name of the subroutine to start and an async behavior setting for handling cases where the subroutine is already running.

```Workshop
Start Rule(SubroutineName, RESTART RULE);
```

--------------------------------

### JavaScript Syntax Highlighting Example

Source: https://workshop.codes/wiki/edits/1303

This snippet shows how to use fenced code blocks with JavaScript for syntax highlighting. It defines a string and then displays an alert.

```markdown
```javascript
var s = "JavaScript syntax highlighting";
alert(s);
```
```

--------------------------------

### Markdown Image Syntax Examples

Source: https://workshop.codes/wiki/edits/851

Demonstrates how to embed images using both inline-style and reference-style Markdown syntax. Supports alt text and title text for images.

```markdown
Here's an image (hover to see the title text):
  *   * Inline-style: 
  * ![alt text](https://d1u1mce87gyfbn.cloudfront.net/game/rank-icons/rank-GrandmasterTier.png "Logo Title Text 1")
  *   * Reference-style: 
  * ![alt text][logo]
  *   * [logo]: https://d1u1mce87gyfbn.cloudfront.net/game/rank-icons/rank-GrandmasterTier.png "Logo Title Text 2"
```

--------------------------------

### Start Game Mode Action

Source: https://workshop.codes/wiki/articles/start%2Bgame%2Bmode

Initiates the game mode. This action is ineffective if the game is already in progress. It returns void and takes no parameters.

```workshop
Start Game Mode;

```
Tokens:
Raw