diff --git a/docs/Modding/AssetPropertiesReferences/ResourceData.md b/docs/Modding/AssetPropertiesReferences/ResourceData.md new file mode 100644 index 00000000..97962408 --- /dev/null +++ b/docs/Modding/AssetPropertiesReferences/ResourceData.md @@ -0,0 +1,62 @@ +# Resource Data + +**Resources** in Unturned allow for players to receive experience or items by destroying or foraging nodes (i.e. trees, ore deposits). + +!!! tip + Properties are formatted as **Property_Key** \\: description + +__Auto_Skybox__: Specifies if the game should generate its own skybox for the resource. + +__BladeID__: Similar to caliber for items. Allows the resource to be destroyed only by an item with the same BladeID. + +__Bypass_ID_Limit__ : Allows you to use an ID that is within the space reserved for vanilla content, the game will throw an exception if you use an ID below 50 otherwise. + +__Chart__ <enum>: `NONE`, `GROUND`, `IGNORE`, `HIGHWAY`, `ROAD`, `STREET`, `PATH`, `LARGE`, `MEDIUM`, `WATER`, `CLIFF`. Specifies what chart color should be used for the resource. + +__Christmas_Redirect__ <guid>: Asset used during Christmas. + +__Exclude_From_Level_Batching__ : Specifies if the resource should be included in level batching. + +__Explosion__ : The effect spawned when the resource is destroyed. + +__Forage__ : Specifies if the resource can be foraged. + +__Forage_Reward_Experience__ : The amount of experience given after being foraged. + +__Has_Clip_Prefab__ : Specifies if the resource has its clip prefabs. + +__Health__ : How much health the resource should spawn with. + +__Holiday_Restriction__ <enum>: `NONE`, `HALLOWEEN`, `CHRISTMAS`, `APRIL_FOOLS`, `VALENTINES`, `PRIDE_MONTH`, `MAX`. Restricts resource visibility to the specified holiday. + +__Halloween_Redirect__ <guid>: Asset used during Halloween. + +__Log__ : The log item spawned when destroyed. + +__No_Debris__ : Specifies if the resource has debris. + +__Radius__ : Radius checked when baking resources on a map. + +__Reset__ : Amount of time it takes for the resource to respawn. + +__Reward_ID__ : The item that should be spawned when destroyed. + +__Reward_Max__ : Maximum amount of items spawned when destroyed. + +__Reward_Min__ : Minimum amount of items spawned when destroyed. + +__Reward_XP__ : The amount of experience that should be given when destroyed. + +__Scale__ : How much the resource can be scaled when being spawned in. + +__SpeedTree__ : Specifies if the resource uses speed tree models. + +__SpeedTree_Default_LOD_Weights__ : Specifies if the LOD weights should default for the speed tree model. + +__Stick__ : The stick item spawned when destroyed. + +__Vulnerable_To_All_Melee_Weapons__ : Specifies if all melee weapons can damage the resource. + +__Vulnerable_To_Fists__ : Specifies if players can damage the resource with their fists. + +__Vertical_Offset__ : How much the resource should be offset vertically when being spawned in. diff --git a/mkdocs.yml b/mkdocs.yml index 4b2cc26c..e5ce3ecb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -140,6 +140,7 @@ nav: - 'Modding/WeatherAsset.md' - Asset Properties References: - 'Modding/AssetPropertiesReferences/ItemData.md' + - 'Modding/AssetPropertiesReferences/ResourceData.md' - 'Modding/AssetPropertiesReferences/VehicleData.md' - 'Modding/VehiclePhysicsProfile.md' - Mapmaking: