Skip to content

Commit

Permalink
Added page for resource data. (#77)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jdance-Media authored Sep 5, 2023
1 parent fa6ddb4 commit 89b4bd5
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 0 deletions.
62 changes: 62 additions & 0 deletions docs/Modding/AssetPropertiesReferences/ResourceData.md
Original file line number Diff line number Diff line change
@@ -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** \<data_type>\: 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__ <flag>: 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__ &lt;enum&gt;: `NONE`, `GROUND`, `IGNORE`, `HIGHWAY`, `ROAD`, `STREET`, `PATH`, `LARGE`, `MEDIUM`, `WATER`, `CLIFF`. Specifies what chart color should be used for the resource.

__Christmas_Redirect__ &lt;guid&gt;: Asset used during Christmas.

__Exclude_From_Level_Batching__ <boolean>: Specifies if the resource should be included in level batching.

__Explosion__ <guidOrLegacy>: The effect spawned when the resource is destroyed.

__Forage__ <flag>: Specifies if the resource can be foraged.

__Forage_Reward_Experience__ <uint32>: The amount of experience given after being foraged.

__Has_Clip_Prefab__ <boolean>: Specifies if the resource has its clip prefabs.

__Health__ <uint16>: How much health the resource should spawn with.

__Holiday_Restriction__ &lt;enum&gt;: `NONE`, `HALLOWEEN`, `CHRISTMAS`, `APRIL_FOOLS`, `VALENTINES`, `PRIDE_MONTH`, `MAX`. Restricts resource visibility to the specified holiday.

__Halloween_Redirect__ &lt;guid&gt;: Asset used during Halloween.

__Log__ <uint16>: The log item spawned when destroyed.

__No_Debris__ <flag>: Specifies if the resource has debris.

__Radius__ <float>: Radius checked when baking resources on a map.

__Reset__ <float>: Amount of time it takes for the resource to respawn.

__Reward_ID__ <uint16>: The item that should be spawned when destroyed.

__Reward_Max__ <uint8>: Maximum amount of items spawned when destroyed.

__Reward_Min__ <uint8>: Minimum amount of items spawned when destroyed.

__Reward_XP__ <uint32>: The amount of experience that should be given when destroyed.

__Scale__ <float>: How much the resource can be scaled when being spawned in.

__SpeedTree__ <flag>: Specifies if the resource uses speed tree models.

__SpeedTree_Default_LOD_Weights__ <flag>: Specifies if the LOD weights should default for the speed tree model.

__Stick__ <uint16>: The stick item spawned when destroyed.

__Vulnerable_To_All_Melee_Weapons__ <boolean>: Specifies if all melee weapons can damage the resource.

__Vulnerable_To_Fists__ <boolean>: Specifies if players can damage the resource with their fists.

__Vertical_Offset__ <float>: How much the resource should be offset vertically when being spawned in.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 89b4bd5

Please sign in to comment.