mirror of
https://github.com/Mukheem/TwinTurbine.git
synced 2025-02-01 06:04:19 +01:00
135 lines
11 KiB
HTML
135 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<title>Proxima Inspector</title>
|
|
<link rel="icon" href="../icons/favicon.ico" />
|
|
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1">
|
|
<meta property="og:type" content="website">
|
|
<meta name="description" property="og:description" content="Proxima Inspector lets you connect to your live game from a web browser to inspect and edit any property. Just like the Unity editor!">
|
|
<meta name="image" property="og:image" content="../images/proxima-1200x630.png">
|
|
<meta http-equiv="content-security-policy" content="">
|
|
<link href="../_app/immutable/assets/_layout-1f0a7e97.css" rel="stylesheet">
|
|
<link href="../_app/immutable/assets/_layout-6847360b.css" rel="stylesheet">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div>
|
|
|
|
|
|
<div class="flex flex-col items-center text-gray-300 w-full min-h-screen bg-[#222]"><div class="flex w-full justify-center items-start bg-[#111] text-white fixed z-20"><div class="flex grow justify-between items-center max-w-[1600px] p-4"><a href="https://www.unityproxima.com"><img src="../images/proxima_logo.png" class="w-[150px]" alt="Logo"></a>
|
|
<button class="lg:hidden"><img class="w-10" src="../icons/menu.png" alt="Menu"></button>
|
|
<div class="flex gap-10 items-center max-lg:hidden">
|
|
<a href="https://assetstore.unity.com/publishers/72095?aid=1101lqSYn" class="text-xl font-logo" referrerpolicy="origin" target="_blank" rel="external">Store</a>
|
|
|
|
<a href="https://app.unityproxima.com/connection" class="text-xl font-logo" referrerpolicy="origin" target="_blank" rel="external">Demo</a>
|
|
|
|
<a class="text-xl font-logo" href="../docs.html">Docs</a>
|
|
|
|
<a href="https://discord.gg/VM9cWJ9rjH" class="" referrerpolicy="origin" target="_blank" rel="external"><img width="100px" class="mt-1" src="../icons/discord.png" alt=""></a></div></div>
|
|
</div>
|
|
|
|
<div class="pt-[83px] w-full h-full flex flex-col items-center"><div class="w-full flex flex-col items-start min-h-screen max-w-[1600px] px-4"><button class="text-white font-body pt-5 lg:hidden">Go to page ></button>
|
|
<div class="flex w-full min-h-full relative"><div class="h-full fixed border-r-orange-400 bg-[#222] border-r-2 max-lg:hidden"><div class="flex pt-10 flex-col w-[300px] gap-2 border-[#21a6f0] min-h-0 h-full overflow-auto"><b class="text-orange-400">Getting Started</b>
|
|
<a href="../docs.html" class="svelte-yue6wq">Installation</a>
|
|
<a href="../docs/features.html" class="svelte-yue6wq">Feature Overview</a>
|
|
|
|
<b class="text-orange-400 mt-5">Connection</b>
|
|
<a href="../docs/supported_platforms.html" class="svelte-yue6wq">Supported Platforms</a>
|
|
<a href="../docs/connect.html" class="svelte-yue6wq">Connect to Your Game</a>
|
|
<a href="../docs/security.html" class="svelte-yue6wq">Security Considerations</a>
|
|
<a href="../docs/all_config.html" class="svelte-yue6wq">All Configuration Options</a>
|
|
|
|
<b class="text-orange-400 mt-5">Inspector</b>
|
|
<a href="../docs/inspector.html" class="svelte-yue6wq">GameObject Inspector</a>
|
|
<a href="../docs/buttons.html" class="svelte-yue6wq">Adding Buttons</a>
|
|
<a href="../docs/faq.html" class="svelte-yue6wq">Frequently Asked Questions</a>
|
|
|
|
<b class="text-orange-400 mt-5">Logs</b>
|
|
<a href="../docs/logs.html" class="svelte-yue6wq">Log Viewer</a>
|
|
<a href="../docs/viewing_logs_offline.html" class="svelte-yue6wq">Viewing Logs Offline</a>
|
|
|
|
<b class="text-orange-400 mt-5">Console</b>
|
|
<a href="../docs/console.html" class="svelte-yue6wq">Console Window</a>
|
|
<a href="../docs/console_built_in.html" class="svelte-yue6wq">Built-in Commands</a>
|
|
<a href="../docs/console_custom.html" class="svelte-yue6wq">Custom Commands</a>
|
|
|
|
<b class="text-orange-400 mt-5">Extras</b>
|
|
<a href="../docs/deeplinks.html" class="svelte-yue6wq">Deep Links</a>
|
|
|
|
<div class="h-[200px] shrink-0"></div></div></div>
|
|
|
|
|
|
<div class="flex flex-col w-full lg:pl-10 py-10 lg:ml-[300px]"><div class="doc flex flex-col gap-5 svelte-yue6wq"><h1>Proxima Inspector FAQ</h1>
|
|
|
|
<div class="bg-[#1d1d1d] p-3 shadow-lg flex gap-2 flex-col text-left"><button><div class="flex gap-2 items-center font-bold"><img class="w-[15px] mt-1" src="../icons/arrow.png" alt="">
|
|
<div>Which property types does Proxima support?</div></div></button>
|
|
<div class=""><div slot="answer"><p>Proxima supports editing most types of properties:</p>
|
|
<div class="m-5"><div class="bg-gray-800 p-5 text-zinc-300"><div class="font-bold mb-3">Supported Property Types:</div>
|
|
<ul class="ml-5 list-disc"><li>All <a href="https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/built-in-types" target="_blank" rel="noreferrer">C# built-in value types</a>, except decimal.</li>
|
|
<li>string, Vector2, Vector2Int, Vector3, Vector3Int, Quaternion, Vector4, Rect, RectInt, Bounds, BoundsInt, Color, LayerMask</li>
|
|
<li>All enums and flags.</li>
|
|
<li>Any struct or class marked as [Serializable] (since Update 1.2).</li>
|
|
<li>View, but not edit, all Unity object references (GameObjects, Components, Assets, etc.)</li>
|
|
<li>Arrays and Lists of any of the above.</li></ul></div></div>
|
|
<p>If you think Proxima is missing an important type, please post your suggestion on the Discord Server.</p></div></div></div>
|
|
|
|
<div class="bg-[#1d1d1d] p-3 shadow-lg flex gap-2 flex-col text-left"><button><div class="flex gap-2 items-center font-bold"><img class="w-[15px] mt-1" src="../icons/arrow.png" alt="">
|
|
<div>Will Proxima Inspector affect my game performance?</div></div></button>
|
|
<div class=""><div class="flex flex-col gap-2" slot="answer"><p>Proxima Inspector is designed to have minimal impact on your game performance. It uses a WebSocket connection to send minimal changes to the browser, and will only performs work when the relevant browser page is open:</p>
|
|
<ul class="list-disc ml-5 flex flex-col gap-2"><li><b>Hierarchy Page</b>: To detect these updates, Proxima will scan up to 10 gameObjects per frame for changes. You can modify this number by changing "ProximaInspector.MaxGameObjectUpdatesPerFrame".</li>
|
|
<li><b>Inspector Page</b>: Proxima will scan one component on the selected gameObject per frame for property changes. You can adjust the frequency each component is scanned by adjusting ProximaInspector.MaxComponentUpdateFrequency.</li>
|
|
<li><b>Logs Page</b>: Proxima records log messages in a circular list so that you can see what happened in the recent past when you visit the Logs page. You can change the size of this list by editing the <b>Log Buffer Size</b> property on the inspector component.</li>
|
|
<li><b>Console Page</b>: No performance impact until a command is issued.</li></ul></div></div></div>
|
|
|
|
<div class="bg-[#1d1d1d] p-3 shadow-lg flex gap-2 flex-col text-left"><button><div class="flex gap-2 items-center font-bold"><img class="w-[15px] mt-1" src="../icons/arrow.png" alt="">
|
|
<div>Why are my root gameObjects out of order?</div></div></button>
|
|
<div class=""><p slot="answer">Unity does not preserve the order of gameObjects in the scene of a built game. Even assigning a sibling index to the transform component will have no effect. This is why you can't reorder root gameObjects.
|
|
</p></div></div>
|
|
|
|
<div class="bg-[#1d1d1d] p-3 shadow-lg flex gap-2 flex-col text-left"><button><div class="flex gap-2 items-center font-bold"><img class="w-[15px] mt-1" src="../icons/arrow.png" alt="">
|
|
<div>Why do some component properties appear differently than in the Editor?</div></div></button>
|
|
<div class=""><p slot="answer">Proxima searches for serialized fields on components to display them in the inspector. This is the same as Unity's default behavior for MonoBehaviours.
|
|
However, some components have custom editors which control their appearance in the Unity inspector.
|
|
All custom editor code is stripped out of a built game, and so Proxima cannot access this information.
|
|
</p></div></div>
|
|
|
|
<div class="bg-[#1d1d1d] p-3 shadow-lg flex gap-2 flex-col text-left"><button><div class="flex gap-2 items-center font-bold"><img class="w-[15px] mt-1" src="../icons/arrow.png" alt="">
|
|
<div>Why are some components missing properties?</div></div></button>
|
|
<div class=""><div slot="answer"><a target="_blank" href="https://docs.unity3d.com/Manual/ManagedCodeStripping.html" rel="noreferrer">Managed Code Stripping</a>
|
|
may be removing some fields or properties from a built game if they are not used by your game code. By default, this happens for built-in Unity component properties which are
|
|
configured in the editor, but not referenced in your code. You can control this setting under <div>"Project Settings > Player > Optimization > Managed Stripping Level"</div><br>
|
|
|
|
<p>Proxima prevents code stripping for many Unity component properties like Transform's localPosition by explicitly referencing them
|
|
in <b>Proxima/Runtime/Generated/ProximaReflection.Generated.cs</b>. You can use one of the techniques described in the link above to prevent your components from being stripped.</p></div></div></div>
|
|
|
|
<div class="bg-[#1d1d1d] p-3 shadow-lg flex gap-2 flex-col text-left"><button><div class="flex gap-2 items-center font-bold"><img class="w-[15px] mt-1" src="../icons/arrow.png" alt="">
|
|
<div>Why are tags not a dropdown list?</div></div></button>
|
|
<div class=""><p slot="answer">Unity does not preserve the list of tags in a built game. You can assign a tag to any string.
|
|
</p></div></div>
|
|
|
|
<div class="bg-[#1d1d1d] p-3 shadow-lg flex gap-2 flex-col text-left"><button><div class="flex gap-2 items-center font-bold"><img class="w-[15px] mt-1" src="../icons/arrow.png" alt="">
|
|
<div>Why does Proxima stop updating when my game is not selected?</div></div></button>
|
|
<div class=""><p slot="answer">Proxima depends on Unity's update loop to detect gameObject and component updates.
|
|
When your game is not in focus, the update loop may be paused. You can configure this setting in Unity under:
|
|
"Project Settings > Player > Resolution and Presentation > Run In Background"
|
|
</p></div></div></div></div></div>
|
|
</div>
|
|
<div class="h-[200px] flex flex-col"><p class="text-gray-400 m-10">© 2023 Virtual Maker Corporation</p></div></div></div>
|
|
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|