Description

Movement speed is a plugin that allows servers to create permission based speed increases for running and swimming.

Server owners can create as many custom permission levels as they desire, and permissions are split between swimming and running, allowing for a lot of flexibility.

The plugin allows for multiple speed boost permissions to be applied, and will select the highest speed modifier where applicable.

This plugin will work great with:

• Skill Tree: This plugin can be used to create a new permission based skill inside of the Skill Tree, and supports leveling up.
• Cooking: A new recipe can be created that will give the player a temporary skill buff when consumed.
• Epic Loot: Add the speed value as part of a set bonus to provide players with faster swimming or running when wearing a set of equipment.

Permission:
movementspeed.admin – allows user of commands.

Commands

• msdisablerun <steam id> – forces the players run speed to be disabled.
• msdisableswim <steam id> – forces the players swim speed to be disabled.
• msenablerun <steam id> – re-enables the run speed.
• msenableswim <steam id> – re-enables the swim speed.
• togglerun – Turns run speed on/off for the command user.
• toggleswim – Turns swim speed on/off for the command user.

Config integration examples

Cooking

      "energy drink": {
        "enabled": true,
        "shortname": "fish.cooked",
        "skin": 3348991998,
        "description": "Pretty sure I can hear colors and taste time right now... anyone else vibrating?",
        "duration": 120,
        "buffs": {
          "Permission": 1.0
        },
        "Commands to run when the player consumes the food [key = command, value = description]": {
          "o.grant user {id} MovementSpeed.run.5": "Increases your movement speed by 100%."
        },
        "Commands to run when the food buff expires": [
          "o.revoke user {id} MovementSpeed.run.5"
        ],
        "persistThroughDeath": false,
        "cookTime": 15.0,
        "useCooldown": 0.0,
        "permissionToCook": null,
        "dropWeight": 100,
        "allowDefaultEffects": false,
        "Effect settings": {
          "Effect to run when the player consumes the meal": "assets/prefabs/clothes/halloween.scarecrow/effects/soul_release_effect.prefab",
          "Should the effect run server side?": true,
          "Max distance heard [0 = no limit]": 20.0
        },
        "Ingredients for meal": {
          "sugar": 5,
          "pineapple": 1,
          "red berry": 2,
          "blue berry": 2
        }
      },

Skill Tree – Swim speed

        "Olympic Swimmer": {
          "Permission required to show this node": null,
          "Minimum prestige required to unlock this node": 0,
          "Skill required to unlock node [Requires max level]": null,
          "Skill that if unlocked, will prevent this node from unlocking": null,
          "enabled": true,
          "max_level": 5,
          "tier": 3,
          "value_per_buff": 1.0,
          "buff_info": {
            "Key": "Permission",
            "Value": "Permission"
          },
          "icon_url": "https://www.dropbox.com/s/6blc3eiarm07rku/cooking%20tree%20example.v1.png?dl=1",
          "skin": 3349007497,
          "permissions": {
            "description": "This node provides you with <color=#42f105>20%</color> faster swim speed per level.",
            "perms": {
              "1": {
                "perms_list": {
                  "MovementSpeed.swim.2": "Swim speed - <color=#61e500>+20%</color>"
                }
              },
              "2": {
                "perms_list": {
                  "MovementSpeed.swim.3": "Swim speed - <color=#61e500>+40%</color>"
                }
              },
              "3": {
                "perms_list": {
                  "MovementSpeed.swim.4": "Swim speed - <color=#61e500>+60%</color>"
                }
              },
              "4": {
                "perms_list": {
                  "MovementSpeed.swim.5": "Swim speed - <color=#61e500>+80%</color>"
                }
              },
              "5": {
                "perms_list": {
                  "MovementSpeed.swim.6": "Swim speed - <color=#61e500>+100%</color>"
                }
              }
            }
          }
        },

Skill Tree – Run Speed

        "Athletic": {
          "Permission required to show this node": null,
          "Minimum prestige required to unlock this node": 0,
          "Skill required to unlock node [Requires max level]": null,
          "Skill that if unlocked, will prevent this node from unlocking": null,
          "enabled": true,
          "max_level": 4,
          "tier": 2,
          "value_per_buff": 1.0,
          "buff_info": {
            "Key": "Permission",
            "Value": "Permission"
          },
          "icon_url": "https://www.dropbox.com/s/6blc3eiarm07rku/cooking%20tree%20example.v1.png?dl=1",
          "skin": 3349007405,
          "permissions": {
            "description": "This node provides you with <color=#42f105>20%</color> faster run speed per level.",
            "perms": {
              "1": {
                "perms_list": {
                  "MovementSpeed.run.2": "Run speed - <color=#61e500>+20%</color>"
                }
              },
              "2": {
                "perms_list": {
                  "MovementSpeed.run.3": "Run speed - <color=#61e500>+40%</color>"
                }
              },
              "3": {
                "perms_list": {
                  "MovementSpeed.run.4": "Run speed - <color=#61e500>+60%</color>"
                }
              },
              "4": {
                "perms_list": {
                  "MovementSpeed.run.5": "Run speed - <color=#61e500>+80%</color>"
                }
              }
            }
          }
        },

API

AddRunSpeedBoost(BasePlayer player, string plugin, float modifier, float duration, bool forceOverwrite)
AddSwimSpeedBoost(BasePlayer player, string plugin, float modifier, float duration, bool forceOverwrite)
RemoveRunSpeed(BasePlayer player, string plugin)
RemoveSwimSpeed(BasePlayer player, string plugin)