|
1103 | 1103 | This value is confusing because in the level editor it is the normalized radius, but in-game it is the square radius. |
1104 | 1104 | </summary> |
1105 | 1105 | </member> |
| 1106 | + <member name="F:SDG.Unturned.SafezoneNode.noBuildables"> |
| 1107 | + <summary> |
| 1108 | + Please check CurrentlyAllowsBuilding. |
| 1109 | + Bypassed by LevelAsset's ShouldAllowBuildingInSafezonesInSingleplayer option. |
| 1110 | + </summary> |
| 1111 | + </member> |
1106 | 1112 | <member name="M:SDG.Unturned.ItemToolAsset.canBeUsedInSafezone(SDG.Unturned.SafezoneNode,System.Boolean)"> |
1107 | 1113 | <summary> |
1108 | 1114 | Tools like carjacks and tires can be used in safezone by admins for maintenance. |
|
3578 | 3584 | Is the Ctrl-C or Ctrl-Break signal being handled? |
3579 | 3585 | </summary> |
3580 | 3586 | </member> |
3581 | | - <member name="T:SDG.Unturned.DamagePlayerParameters"> |
| 3587 | + <member name="F:SDG.Unturned.ELoadingTip.MAX"> |
3582 | 3588 | <summary> |
3583 | | - Payload for the DamageTool.damagePlayer function. |
| 3589 | + Marker for counting number of tips. |
3584 | 3590 | </summary> |
3585 | 3591 | </member> |
3586 | | - <member name="F:SDG.Unturned.DamagePlayerParameters.respectArmor"> |
| 3592 | + <member name="F:SDG.Unturned.LoadingUI.placeholderCamera"> |
3587 | 3593 | <summary> |
3588 | | - Should armor worn on matching limb be factored in? |
| 3594 | + Camera used while transitioning between scenes to prevent the "no cameras rendering" warning. |
3589 | 3595 | </summary> |
3590 | 3596 | </member> |
3591 | | - <member name="F:SDG.Unturned.DamagePlayerParameters.applyGlobalArmorMultiplier"> |
| 3597 | + <member name="F:SDG.Unturned.LoadingUI.pingWarning"> |
3592 | 3598 | <summary> |
3593 | | - Should game mode config damage multiplier be factored in? |
| 3599 | + Shown when game connection ping is significantly higher than server browser ping. At the time of writing |
| 3600 | + (2025-01-17) this is likely because the server is using an "anycast proxy" in front of Steam A2S cache. |
3594 | 3601 | </summary> |
3595 | 3602 | </member> |
3596 | | - <member name="F:SDG.Unturned.DamagePlayerParameters.trackKill"> |
| 3603 | + <member name="F:SDG.Unturned.LoadingUI.lastLoading"> |
3597 | 3604 | <summary> |
3598 | | - If player dies should it count towards quests? |
| 3605 | + Set to Time.frameCount + 1 while loading. |
| 3606 | + In the past used realtime, but that was unreliable if an individual frame took too long. |
3599 | 3607 | </summary> |
3600 | 3608 | </member> |
3601 | | - <member name="F:SDG.Unturned.DamagePlayerParameters.ragdollEffect"> |
| 3609 | + <member name="M:SDG.Unturned.LoadingUI.PickNonLevelBackgroundImage"> |
3602 | 3610 | <summary> |
3603 | | - Effect to apply to ragdoll if dead. |
| 3611 | + Select a loading image while on the startup screen or a level without any images. |
3604 | 3612 | </summary> |
3605 | 3613 | </member> |
3606 | | - <member name="F:SDG.Unturned.ELoadingTip.MAX"> |
| 3614 | + <member name="T:SDG.Unturned.DamagePlayerParameters"> |
3607 | 3615 | <summary> |
3608 | | - Marker for counting number of tips. |
| 3616 | + Payload for the DamageTool.damagePlayer function. |
3609 | 3617 | </summary> |
3610 | 3618 | </member> |
3611 | | - <member name="F:SDG.Unturned.LoadingUI.placeholderCamera"> |
| 3619 | + <member name="F:SDG.Unturned.DamagePlayerParameters.respectArmor"> |
3612 | 3620 | <summary> |
3613 | | - Camera used while transitioning between scenes to prevent the "no cameras rendering" warning. |
| 3621 | + Should armor worn on matching limb be factored in? |
3614 | 3622 | </summary> |
3615 | 3623 | </member> |
3616 | | - <member name="F:SDG.Unturned.LoadingUI.pingWarning"> |
| 3624 | + <member name="F:SDG.Unturned.DamagePlayerParameters.applyGlobalArmorMultiplier"> |
3617 | 3625 | <summary> |
3618 | | - Shown when game connection ping is significantly higher than server browser ping. At the time of writing |
3619 | | - (2025-01-17) this is likely because the server is using an "anycast proxy" in front of Steam A2S cache. |
| 3626 | + Should game mode config damage multiplier be factored in? |
3620 | 3627 | </summary> |
3621 | 3628 | </member> |
3622 | | - <member name="F:SDG.Unturned.LoadingUI.lastLoading"> |
| 3629 | + <member name="F:SDG.Unturned.DamagePlayerParameters.trackKill"> |
3623 | 3630 | <summary> |
3624 | | - Set to Time.frameCount + 1 while loading. |
3625 | | - In the past used realtime, but that was unreliable if an individual frame took too long. |
| 3631 | + If player dies should it count towards quests? |
3626 | 3632 | </summary> |
3627 | 3633 | </member> |
3628 | | - <member name="M:SDG.Unturned.LoadingUI.PickNonLevelBackgroundImage"> |
| 3634 | + <member name="F:SDG.Unturned.DamagePlayerParameters.ragdollEffect"> |
3629 | 3635 | <summary> |
3630 | | - Select a loading image while on the startup screen or a level without any images. |
| 3636 | + Effect to apply to ragdoll if dead. |
3631 | 3637 | </summary> |
3632 | 3638 | </member> |
3633 | 3639 | <member name="F:SDG.Unturned.ESteamCallValidation.ONLY_FROM_SERVER"> |
|
3762 | 3768 | <member name="P:SDG.Unturned.Logs.ShouldRedactLogs"> |
3763 | 3769 | <summary> |
3764 | 3770 | If true, information like IP addresses and login tokens should be censored in vanilla logs. |
3765 | | - Nelson 2024-11-11: Special thanks to Jdance and asineth0 in public issue #4740! |
| 3771 | + (public issue #4740) |
3766 | 3772 | </summary> |
3767 | 3773 | </member> |
3768 | 3774 | <member name="P:SDG.Unturned.Logs.RedactionReplacement"> |
|
6049 | 6055 | Absolute path to the map folder. |
6050 | 6056 | </summary> |
6051 | 6057 | </member> |
6052 | | - <member name="P:SDG.Unturned.LevelInfo.canAnalyticsTrack"> |
6053 | | - <summary> |
6054 | | - Whether unity analytics should track this map's name. Don't want to burn all the analysis points! |
6055 | | - </summary> |
6056 | | - </member> |
6057 | | - <member name="P:SDG.Unturned.LevelInfo.isSpecial"> |
6058 | | - <summary> |
6059 | | - Maps included with the game only, separate from category because arena maps are misc. |
6060 | | - Category is set as part of the config file. This is only mainly used to enable unity analytics tracking for map name. |
6061 | | - </summary> |
6062 | | - </member> |
6063 | 6058 | <member name="P:SDG.Unturned.LevelInfo.isFromWorkshop"> |
6064 | 6059 | <summary> |
6065 | 6060 | Only used for play menu categories at the moment. |
|
7381 | 7376 | Note: this is the list as-configured. It has not been filtered according to gameplay config. |
7382 | 7377 | </summary> |
7383 | 7378 | </member> |
| 7379 | + <member name="P:SDG.Unturned.Blueprint.RequiresStaticTags"> |
| 7380 | + <summary> |
| 7381 | + Not shown in the UI. These tags are checked once per-level-startup. |
| 7382 | + For example, used to check for "singleplayer" tag or a map-specific tag. |
| 7383 | + </summary> |
| 7384 | + </member> |
7384 | 7385 | <member name="F:SDG.Unturned.Blueprint.withoutAttachments"> |
7385 | 7386 | <summary> |
7386 | 7387 | If true, and transferState is enabled, delete attached items. |
|
7398 | 7399 | </member> |
7399 | 7400 | <member name="F:SDG.Unturned.Blueprint.canBeVisibleWhenSearchedWithoutRequiredItems"> |
7400 | 7401 | <summary> |
7401 | | - 2023-05-27: requested by Renaxon because some Arid blueprints are debug-only and |
7402 | | - should not be visible when players search by name. (the 3.23.7.0 update made |
7403 | | - non-craftable blueprints searchable for Buak) |
| 7402 | + Useful for hiding developer/debug internal blueprints that should not be visible when players search by name. |
7404 | 7403 | </summary> |
7405 | 7404 | </member> |
7406 | 7405 | <member name="P:SDG.Unturned.Blueprint.CanBeVisibleWithUnmetConditions"> |
|
10523 | 10522 | <member name="F:SDG.Unturned.ReceivedChatMessage.useRichTextFormatting"> |
10524 | 10523 | <summary> |
10525 | 10524 | Whether this entry should enable rich text formatting. |
10526 | | - False by default because players abuse font size and ugly colors. |
| 10525 | + False by default to prevent players including markup themselves. |
10527 | 10526 | </summary> |
10528 | 10527 | </member> |
10529 | 10528 | <member name="F:SDG.Unturned.ReceivedChatMessage.contents"> |
|
12576 | 12575 | OR use the nearly drop-in replacements FindFirstItemByAsset or HasItemByAsset. |
12577 | 12576 | </summary> |
12578 | 12577 | </member> |
| 12578 | + <member name="M:SDG.Unturned.SteamBBCodeUtils.removeYouTubePreviews(System.String@)"> |
| 12579 | + <summary> |
| 12580 | + In-game rich text does not support embedded YouTube videos, but they look great in the web browser, |
| 12581 | + so we simply remove them from the in-game text. |
| 12582 | + </summary> |
| 12583 | + </member> |
| 12584 | + <member name="M:SDG.Unturned.SteamBBCodeUtils.removeCodeFormatting(System.String@)"> |
| 12585 | + <summary> |
| 12586 | + Unfortunately in-game rich text does not have code formatting yet, so remove the tags while preserving text. |
| 12587 | + </summary> |
| 12588 | + </member> |
12579 | 12589 | <member name="P:SDG.Unturned.ItemClothingAsset.armor"> |
12580 | 12590 | <summary> |
12581 | 12591 | Multiplier to incoming damage. Defaults to 1.0. |
|
12644 | 12654 | If true, the real item is shown rather than the cosmetic item. If false, the cosmetic item can be seen. |
12645 | 12655 | </summary> |
12646 | 12656 | </member> |
12647 | | - <member name="M:SDG.Unturned.SteamBBCodeUtils.removeYouTubePreviews(System.String@)"> |
12648 | | - <summary> |
12649 | | - In-game rich text does not support embedded YouTube videos, but they look great in the web browser, |
12650 | | - so we simply remove them from the in-game text. |
12651 | | - </summary> |
12652 | | - </member> |
12653 | | - <member name="M:SDG.Unturned.SteamBBCodeUtils.removeCodeFormatting(System.String@)"> |
12654 | | - <summary> |
12655 | | - Unfortunately in-game rich text does not have code formatting yet, so remove the tags while preserving text. |
12656 | | - </summary> |
12657 | | - </member> |
12658 | 12657 | <member name="M:SDG.Unturned.ListExtension.GetRandomIndex``1(System.Collections.Generic.List{``0})"> |
12659 | 12658 | <summary> |
12660 | 12659 | Get index within bounds assuming list is not empty. |
|
12690 | 12689 | If not null and damage is applied, <see cref="M:SDG.Unturned.Zombie.alert(SDG.Unturned.Player)"/> is called with this position (startle: true). |
12691 | 12690 | </summary> |
12692 | 12691 | </member> |
| 12692 | + <member name="T:SDG.Unturned.IArmorFalloff"> |
| 12693 | + <summary> |
| 12694 | + Implemented by assets which gun supports checking for damage falloff. |
| 12695 | + When implemented, PopulateAsset should call PopulateArmorFalloff. |
| 12696 | + </summary> |
| 12697 | + </member> |
| 12698 | + <member name="P:SDG.Unturned.IArmorFalloff.ArmorFalloffMaxRange"> |
| 12699 | + <summary> |
| 12700 | + Ranged damage (guns) from greater than this distance finishes decreasing toward falloff multiplier. |
| 12701 | + Defaults to -1, in which case armor falloff is ignored. |
| 12702 | + </summary> |
| 12703 | + </member> |
| 12704 | + <member name="P:SDG.Unturned.IArmorFalloff.ArmorFalloffRange"> |
| 12705 | + <summary> |
| 12706 | + Ranged damage (guns) from greater than this distance begins decreasing toward falloff multiplier. |
| 12707 | + Defaults to ArmorFalloffMaxRange. |
| 12708 | + </summary> |
| 12709 | + </member> |
| 12710 | + <member name="P:SDG.Unturned.IArmorFalloff.ArmorFalloffMultiplier"> |
| 12711 | + <summary> |
| 12712 | + [0, 1] normalized percentage of incoming damage to apply past IncomingDamageFalloffMaxRange. |
| 12713 | + </summary> |
| 12714 | + </member> |
| 12715 | + <member name="M:SDG.Unturned.IArmorFalloffEx.DoesArmorFalloffShowHitmarker(SDG.Unturned.IArmorFalloff,System.Single)"> |
| 12716 | + <summary> |
| 12717 | + Should hitmarker be shown client-side for a given range? |
| 12718 | + </summary> |
| 12719 | + </member> |
| 12720 | + <member name="M:SDG.Unturned.IArmorFalloffEx.GetArmorFalloffMultiplier(SDG.Unturned.IArmorFalloff,System.Single)"> |
| 12721 | + <summary> |
| 12722 | + Amount to multiply damage by at a given range. |
| 12723 | + </summary> |
| 12724 | + </member> |
12693 | 12725 | <member name="P:SDG.Unturned.SleekButtonState.UseContentTooltip"> |
12694 | 12726 | <summary> |
12695 | 12727 | If true, button tooltip will be overridden with tooltip from states array. |
|
14496 | 14528 | Players are kicked from multiplayer if their skin color is within threshold of any of these rules. |
14497 | 14529 | </summary> |
14498 | 14530 | </member> |
| 14531 | + <member name="P:SDG.Unturned.LevelAsset.ShouldAllowBuildingInSafezonesInSingleplayer"> |
| 14532 | + <summary> |
| 14533 | + If true, bypasses SafezoneNode no-buildables mode in singleplayer. |
| 14534 | + </summary> |
| 14535 | + </member> |
| 14536 | + <member name="P:SDG.Unturned.LevelAsset.Tags"> |
| 14537 | + <summary> |
| 14538 | + Blueprints can test for these tags. (Future extension here?) |
| 14539 | + </summary> |
| 14540 | + </member> |
14499 | 14541 | <member name="T:SDG.Unturned.EAimAlignmentTransformOwner"> |
14500 | 14542 | <summary> |
14501 | 14543 | Controls where attachments looks for ADS alignment transform. |
|
17062 | 17104 | transform.position used to test whether vehicle is moving. |
17063 | 17105 | </summary> |
17064 | 17106 | </member> |
| 17107 | + <member name="M:SDG.Unturned.InteractableVehicle.NotifyFirstSpawned"> |
| 17108 | + <summary> |
| 17109 | + Should be called AFTER replication (if applicable) so that events can call methods relying on replication. |
| 17110 | + </summary> |
| 17111 | + </member> |
17065 | 17112 | <member name="F:SDG.Unturned.PlayerNPCDialogueUI.hasNextDialogue"> |
17066 | 17113 | <summary> |
17067 | 17114 | If true, the player can press Interact [F] when there are no responses |
|
19934 | 19981 | Maps region coord to a list of sub-road renderers in that region. |
19935 | 19982 | Unlike older "region" features, coord can be outside of the old bounds. |
19936 | 19983 | Not used in the editor or the dedicated server. |
19937 | | - |
19938 | | - Nelson 2025-03-28: experimenting with this to see whether it reduces time spent culling far-away road |
19939 | | - renderers on Rio de Janeiro Remastered. (Lots of roads on this map.) |
19940 | 19984 | </summary> |
19941 | 19985 | </member> |
19942 | 19986 | <member name="P:SDG.Unturned.LevelRoads.RoadMaxDistance"> |
|
20278 | 20322 | Used when creating/deleting levels, as well as following workshop changes. |
20279 | 20323 | </summary> |
20280 | 20324 | </member> |
| 20325 | + <member name="F:SDG.Unturned.Level.cachedStaticTags"> |
| 20326 | + <summary> |
| 20327 | + Initialized along with level asset. |
| 20328 | + </summary> |
| 20329 | + </member> |
20281 | 20330 | <member name="M:SDG.Unturned.Level.getAsset"> |
20282 | 20331 | <summary> |
20283 | 20332 | Get level's cached asset, if any. |
|
0 commit comments