Search Unity

  1. Welcome to the Unity Forums! Please take the time to read our Code of Conduct to familiarize yourself with the forum rules and how to post constructively.
  2. We have updated the language to the Editor Terms based on feedback from our employees and community. Learn more.
    Dismiss Notice

I put the docs in related and hierarchical, here

Discussion in 'Documentation' started by feiting, Jan 26, 2015.

  1. feiting

    feiting

    Joined:
    Oct 26, 2012
    Posts:
    33
    It's just text with titles, but it will help the brain grasp Unity's systems instead of trying to memorize an entire list. Like the poor fellow who tries to memorize Kanji letters one by one, when they should be writing whole words in a journal for better memory.

    Meta, Unity, my coworkers and I all believe you've just been growing too fast to keep up with docs, no hard feelings :).

    Edit: Oh yes, some classes marked as "not in unity namespace -n" control classes that are in the namespace. I was wondering just what that is and if/why/how it matters and any examples, thanks!

    I use code insertion to maintain the spacing. nodoc and out of order (NS stuff) might be worth creating a bug for. The Object subclasses are marked with ---- and not in relational order, just by subclassing. I have to figure out how to do that, and some of the graphics, 3D, and similar classes are in Misc since I couldn't tell where they should go. I might keep them under Object but rearranged, and eventually hope to make HTML pages where I put in related topics.

    I did not know some of these classes were animation-related, so I did learn valuable things by not having this in flat order. I hope others will benefit from this hierarchy and also change it to improve. If not, I will continue. My next step is to eliminate superclass functions within the descriptions, and to group functions by what they do within classes. That will take a lot longer, and I'll have to write html for every page. Not looking forward to it, but I can prototype applications in iOS within hours thanks to similar memorization of how it works, and I want that speed in unity, so I'm doing this

    Oh, and I couldn't find anything on sprites in the manual, it's all scattered. I think the tutorials are the only place for it, not that I need it at the moment, just went to brush up and couldn't find sprite info, like rendering order and how to use, etc. I already know how to use it and 2d colliders, just seems disjointed to not have it in a findable area. Ok, sounds like I'm critiquing too much, here's your gift:

    Code (CSharp):
    1. Note: n means not in {UnityEngine}.
    2. nodoc means the documentation had nothing on the fields.
    3. Other notes in parentheses.
    4. Mobile Category
    5.     iOS
    6.         ADInterstitialAd
    7.         ADBannerView
    8.         RemoteNotification
    9.         NSError nodocumentation (nodoc for short)
    10.         NSNotification nodoc
    11.         iPhoneInput nodoc
    12.         LocalNotification
    13.         NotificationServices
    14.      
    15.     Android
    16.         AndroidInput
    17.         AndroidJavaProxy
    18.         AndroidJavaObject
    19.             AndroidJavaClass
    20.         AndroidJNI
    21.         AndroidJNIHelper
    22.         AndroidJavaException
    23.     Social (mostly for iOS but adapts to any device)
    24.  
    25. Animation Category
    26.     RuntimeAnimatorController
    27.         AnimatorOverrideController
    28.     AnimationClipPair
    29.     AnimationCurve
    30.     AnimationEvent
    31.     AnimationInfo n
    32.     TrackedReference
    33.         AnimationState
    34.     AnimatorStateInfo n
    35.     AnimatorTransitionInfo n
    36.     MatchTargetWeightMask n
    37.     AnimatorUtility
    38.     BoneWeight n
    39.     SkeletonBone n
    40.     AvatarBuilder
    41.     HumanBone n
    42.     HumanDescription n
    43.     HumanLimit n
    44.     HumanTrait n
    45.     Keyframe n
    46.  
    47. Editor Classes
    48.     AssemblyIsEditorAssembly (Attribute, but has function...)
    49.     ADDComponentMenu
    50.     ContextMenu (attrib)
    51.     CrashReport
    52.     Cursor
    53.     HideInInspector(Attrib.)
    54.     StackTraceUtility nodoc
    55.     Gizmos
    56.  
    57. Input Category
    58.     Touch n
    59.     Input
    60.     TouchScreenKeyboard
    61.  
    62. Attributes-
    63.     RequireComponent (Attrib.)
    64.     RPC (Attrib)
    65.     DisallowMultipleComponent (attr.)
    66.     ExecuteInEditMode (att)
    67.  
    68. Networking Category
    69.     Network
    70.     NetworkMessageInfo n
    71.     NetworkPlayer n
    72.     NetworkViewID n
    73.     Ping
    74.     WWW
    75.     WWWForm
    76.     BitStream
    77.     Security
    78.     HostData
    79.     MasterServer
    80.  
    81. System Category
    82.     Application
    83.     YieldInstruction
    84.         AsyncOperation
    85.             AssetBundleCreateRequest
    86.             AssetBundleRequest
    87.             ResourceRequest
    88.         Coroutine
    89.         WaitForEndOfFrame
    90.         WaitForFixedUpdate
    91.         WaitForSeconds
    92.     AudioSettings
    93.     Time
    94.     Random
    95.     Debug
    96.     UnassignedReferenceException nodoc
    97.     UnityException nodoc
    98.     PlayerPrefs
    99.     PlayerPrefsException
    100.     Profiler (pro-only)
    101.  
    102. Assets Category
    103.     Caching
    104.     Resources
    105.     SerializeField
    106.  
    107. GUI Category
    108.     GUI
    109.     GUIContent
    110.     GUILayout
    111.     GUILayoutOption
    112.     GUILayoutUtility
    113.     GUISettings
    114.     GUIStyle
    115.     GUIStyleState
    116.     GUIUtility
    117.     UIVertex n
    118.     Event
    119.  
    120. Device Category
    121.     AccelerationEvent n
    122.     SamsungTV
    123.     iPhone
    124.     LocationInfo n
    125.     LocationService
    126.     Gyroscope
    127.     SystemInfo
    128.     WebCamDevice n
    129.     Microphone
    130.     Handheld
    131.  
    132. Text Category
    133.     TextEditor nodoc
    134.     TextGenerationSettings n
    135.     TextGenerator
    136.     UICharInfo n
    137.     CharacterInfo n
    138.  
    139. Display Category
    140.     Screen
    141.     Compass
    142.     Resolution n
    143.     StaticBatchingUtility (reduces draw calls)
    144.     SleepTimeout (dimming)
    145.     Display
    146.  
    147. 3D Objects and Math Cat.
    148.     Vector2 n
    149.     Vector3 n
    150.     Vector4 n
    151.     Mathf n
    152.     Matrix4x4 n
    153.     Bounds n
    154.     Quaternion n
    155.     Rect n
    156.     RectOffset
    157.     RectTransformUtility
    158.     GeometryUtility
    159.     Plane n
    160.     CombineInstance n
    161.  
    162. Physics Category
    163.     Collision
    164.     Collision2D
    165.     ContactPoint n
    166.     ContactPoint2D n
    167.     ControllerColliderHit
    168.     CollisionEvent n
    169.     Physics
    170.     Physics2D
    171.     Ray n
    172.     Ray2D n
    173.     RaycastHit n
    174.     RaycastHit2D n
    175.     SoftJointLimit n
    176.     JointAngleLimits2D n
    177.     JointDrive n
    178.     JointLimits n
    179.     JointMotor n
    180.     JointMotor2D n
    181.     JointSpring n
    182.     JointSuspension2D n
    183.     JointTranslationLimits2D n
    184.     WheelFrictionCurve n
    185.     WheelHit n
    186.  
    187. Graphics Category
    188.     Color n
    189.     Color32 n
    190.     Gradient
    191.     GradientAlphaKey n
    192.     GradientColorKey n
    193.     Graphics
    194.     ImageEffectOpaque
    195.     ImageEffectTransformsToLDR
    196.     Particle nodoc kinda
    197.     Particle (duplicate, has more information than other one)
    198.     ComputeBuffer
    199.     DrivenRectTransformTracker n (tracks a rectangle)
    200.     GL
    201.     LightmapData
    202.     MaterialPropertyBlock
    203.     ProceduralPropertyDescription
    204.     RenderBuffer n
    205.  
    206. Terrain Category
    207.     TrackedReference nodoc
    208.     SplatPrototype
    209.     TreeInstance n nodoc
    210.     TreePrototype nodoc
    211.     Types nodoc
    212.     DetailPrototype
    213.  
    214. Misc Classes
    215.     ClothSkinningCoefficient n
    216.     LOD n
    217.     NavMeshHit n
    218.     NavMeshPath
    219.     NavMeshTriangulation n
    220.     OffMeshLinkData
    221.     LayerMask n
    222.     MissingComponentException nodoc
    223.     MissingReferenceException nodoc
    224.  
    225. Object ---------------------------------------------------------------------------
    226.     AudioClip
    227.     AssetBundle
    228.     Avatar
    229.     Component
    230.         Behaviour
    231.             Animator
    232.             Animation
    233.             AudioChorusFilter
    234.             AudioDistortionFilter
    235.             AudioEchoFilter
    236.             AudioHighPassFilter
    237.             AudioListener
    238.             AudioLowPassFilter
    239.             AudioReverbFilter
    240.             AudioReverbZone
    241.             AudioSource
    242.             Camera (sub Behaviour - for clarity since tall when typing)
    243.             Canvas
    244.             Collider2D
    245.                 BoxCollider2D
    246.                 EdgeCollider2D
    247.                 CircleCollider2D
    248.                 PolygonCollider2D
    249.              
    250.             ConstantForce
    251.             Joint2D
    252.                 DistanceJoint2D
    253.                 AnchoredJoint2D
    254.                     HingeJoint2D
    255.                     SliderJoint2D
    256.                     SpringJoint2D
    257.                     WheelJoint2D
    258.             GUIElement (sub Behaviour)
    259.                 GUIText
    260.                 GUITexture
    261.             GUILayer
    262.             LensFlare
    263.             Light
    264.             MonoBehaviour -base class every script derives-
    265.                 Terrain
    266.             NavMeshAgent (sub Behaviour)
    267.             NavMeshObstacle
    268.             NetworkPlayer
    269.             Projector
    270.             Skybox
    271.         Cloth
    272.             InteractiveCloth
    273.             SkinnedCloth
    274.         CanvasGroup
    275.         CanvasRenderer
    276.         Joint
    277.             CharacterJoint
    278.             ConfigurableJoint
    279.             FixedJoint
    280.             HingeJoint
    281.             SpringJoint
    282.         Collider (sub component)
    283.             CapsuleCollider
    284.             BoxCollider
    285.             CharacterController
    286.             MeshCollider
    287.             SphereCollider
    288.             TerrainCollider
    289.             WheelCollider
    290.         LightProbeGroup (sub component)
    291.         LODGroup
    292.         MeshFilter
    293.         OcclusionArea
    294.         OcclusionPortal
    295.         OffMeshLink
    296.         ParticleAnimator
    297.         ParticleEmitter
    298.         ParticleSystem
    299.         Transform
    300.             RectTransform
    301.      
    302.         Renderer
    303.             ClothRenderer
    304.             LineRenderer
    305.             MeshRenderer
    306.             ParticleRenderer
    307.             ParticleSystemRenderer
    308.             SkinnedMeshRenderer
    309.             SpriteRenderer
    310.             TrailRenderer
    311.         Rigidbody (sub component)
    312.         Rigidbody2D
    313.         TextMesh
    314.         Tree
    315.     ComputeShader (sub object)
    316.     Flare
    317.     Font
    318.     GameObject
    319.     LightmapSettings
    320.     LightProbes
    321.     Material
    322.         ProceduralMaterial
    323.     Mesh
    324.     Motion
    325.         AnimationClip
    326.     Texture
    327.         Cubemap
    328.         MovieTexture
    329.         ProceduralTexture
    330.         RenderTexture
    331.         SparseTexture
    332.         Texture2D
    333.         Texture3D
    334.         WebCamTexture
    335.     NavMesh
    336.     PhysicMaterial
    337.     PhysicsMaterial2D
    338.     QualitySettings
    339.     RenderSettings
    340.     RuntimeAnimatorController
    341.     ScriptableObject
    342.         GUISkin
    343.     Shader
    344.     Sprite
    345.     TerrainData
    346.     TextAsset
     
    Rudranil95y, AntonioModer and mgear like this.
  2. feiting

    feiting

    Joined:
    Oct 26, 2012
    Posts:
    33
    Hey, I'm trying to find a decent way to copy and paste the functions yet they're in a table so I can't group them without individually copying every cell then rearranging it in a word document. I'm assuming your docs are generated via php or perl or another script? Mind modifying that and handing some docs that are easier to rearrange? This is taking a ridiculous amount of time for a small number of classes.

    In the meantime I'll just rearrange the inherited list into the category list.

    Thanks
     
  3. feiting

    feiting

    Joined:
    Oct 26, 2012
    Posts:
    33
    Here's the version with pure categories.
    Suggested edits: Graphics vs shaders vs objects that affect graphics.
    2D Category including physics objects.
    NavMesh stuff, and perhaps re-organizing into subclasses.
    But with this, it's easy to start.

    Code (CSharp):
    1. Mobile Category
    2.     iOS
    3.         ADInterstitialAd
    4.         ADBannerView
    5.         RemoteNotification
    6.         NSError nodoc
    7.         NSNotification nodoc
    8.         iPhoneInput nodoc
    9.         LocalNotification
    10.         NotificationServices
    11.        
    12.     Android
    13.         AndroidInput
    14.         AndroidJavaProxy
    15.         AndroidJavaObject
    16.             AndroidJavaClass
    17.         AndroidJNI
    18.         AndroidJNIHelper
    19.         AndroidJavaException
    20.     Social (mostly for iOS but adapts to any device)
    21.  
    22. Animation Category
    23.     Motion
    24.     AnimationClip
    25.     Animator
    26.     Animation
    27.     RuntimeAnimatorController
    28.         AnimatorOverrideController
    29.     AnimationClipPair
    30.     AnimationCurve
    31.     AnimationEvent
    32.     AnimationInfo n
    33.     TrackedReference
    34.         AnimationState
    35.     AnimatorStateInfo n
    36.     AnimatorTransitionInfo n
    37.     MatchTargetWeightMask n
    38.     AnimatorUtility
    39.     BoneWeight n
    40.     SkeletonBone n
    41.     AvatarBuilder
    42.     HumanBone n
    43.     HumanDescription n
    44.     HumanLimit n
    45.     HumanTrait n
    46.     Keyframe n
    47.     Avatar
    48.     RuntimeAnimatorController
    49.  
    50.  
    51. Editor Classes
    52.     AssemblyIsEditorAssembly (Attribute, but has function...)
    53.     ADDComponentMenu
    54.     ContextMenu (attrib)
    55.     CrashReport
    56.     Cursor
    57.     HideInInspector(Attrib.)
    58.     StackTraceUtility nodoc
    59.     Gizmos
    60.    
    61. Input Category
    62.     Touch n
    63.     Input
    64.     TouchScreenKeyboard
    65.  
    66. Attributes-
    67.     RequireComponent (Attrib.)
    68.     RPC (Attrib)
    69.     DisallowMultipleComponent (attr.)
    70.     ExecuteInEditMode (att)
    71.  
    72. Networking Category
    73.     Network
    74.     NetworkMessageInfo n
    75.     NetworkPlayer n
    76.     NetworkViewID n
    77.     Ping
    78.     WWW
    79.     WWWForm
    80.     BitStream
    81.     Security
    82.     HostData
    83.     MasterServer
    84.     NetworkPlayer
    85.  
    86. System Category
    87.     Application
    88.     YieldInstruction
    89.     AsyncOperation
    90.     AssetBundleCreateRequest
    91.     AssetBundleRequest
    92.     ResourceRequest
    93.     Coroutine
    94.     WaitForEndOfFrame
    95.     WaitForFixedUpdate
    96.     WaitForSeconds
    97.     AudioSettings
    98.     Time
    99.     Random
    100.     Debug
    101.     UnassignedReferenceException nodoc
    102.     UnityException nodoc
    103.     PlayerPrefs
    104.     PlayerPrefsException
    105.     Profiler (pro-only)
    106.     QualitySettings
    107.     RenderSettings
    108.  
    109. Assets Category
    110.     Caching
    111.     Resources
    112.     SerializeField
    113.     TextAsset
    114.     AssetBundle
    115.  
    116.     —Audio Subcategory—
    117.     AudioClip
    118.     AudioChorusFilter
    119.     AudioDistortionFilter
    120.     AudioEchoFilter
    121.     AudioHighPassFilter
    122.     AudioListener
    123.     AudioLowPassFilter
    124.     AudioReverbFilter
    125.     AudioReverbZone  
    126.     AudioSource
    127.  
    128.  
    129. GUI Category
    130.     GUI
    131.     GUIContent
    132.     GUILayout
    133.     GUILayoutOption
    134.     GUILayoutUtility
    135.     GUISettings
    136.     GUIStyle
    137.     GUIStyleState
    138.     GUIUtility
    139.     UIVertex n
    140.     Event
    141.     Canvas
    142.     GUIElement (sub Behaviour)
    143.     GUIText
    144.     GUITexture
    145.     GUILayer
    146.     CanvasGroup
    147.     CanvasRenderer
    148.     GUISkin
    149.  
    150. Device Category
    151.     AccelerationEvent n
    152.     SamsungTV
    153.     iPhone
    154.     LocationInfo n
    155.     LocationService
    156.     Gyroscope
    157.     SystemInfo
    158.     WebCamDevice n
    159.     Microphone
    160.     Handheld
    161.  
    162. Text Category
    163.     TextEditor nodoc
    164.     TextGenerationSettings n
    165.     TextGenerator
    166.     UICharInfo n
    167.     CharacterInfo n
    168.    
    169. Display Category
    170.     Screen
    171.     Compass
    172.     Resolution n
    173.     StaticBatchingUtility (reduces draw calls)
    174.     SleepTimeout (dimming)
    175.     Display
    176.  
    177. 3D Objects and Math Cat.
    178.     Transform
    179.     RectTransform
    180.     Vector2 n
    181.     Vector3 n
    182.     Vector4 n
    183.     Mathf n
    184.     Matrix4x4 n
    185.     Bounds n
    186.     Quaternion n
    187.     Rect n
    188.     RectOffset
    189.     RectTransformUtility
    190.     GeometryUtility
    191.     Plane n
    192.     CombineInstance n
    193.     MeshFilter
    194.     TextMesh (Makes a 3D object, the text classes don’t seem to operate the same)
    195.     Material (This is “what” renders so not in graphics. “How” goes into graphics)
    196.     ProceduralMaterial
    197.     Mesh
    198.  
    199. Physics Category
    200.     Collision
    201.     Collision2D
    202.     ContactPoint n
    203.     ContactPoint2D n
    204.     ControllerColliderHit
    205.     CollisionEvent n
    206.     Physics
    207.     Physics2D
    208.     Ray n
    209.     Ray2D n
    210.     RaycastHit n
    211.     RaycastHit2D n  
    212.     SoftJointLimit n
    213.     JointAngleLimits2D n
    214.     JointDrive n
    215.     JointLimits n
    216.     JointMotor n
    217.     JointMotor2D n
    218.     JointSpring n
    219.     JointSuspension2D n
    220.     JointTranslationLimits2D n
    221.     WheelFrictionCurve n
    222.     WheelHit n
    223.     Collider2D
    224.     BoxCollider2D
    225.     EdgeCollider2D
    226.     CircleCollider2D
    227.     PolygonCollider2D
    228.     ConstantForce
    229.     Joint2D
    230.     DistanceJoint2D
    231.     AnchoredJoint2D
    232.     HingeJoint2D
    233.     SliderJoint2D
    234.     SpringJoint2D
    235.     WheelJoint2D
    236.     Joint
    237.     CharacterJoint
    238.     ConfigurableJoint
    239.     FixedJoint
    240.     HingeJoint
    241.     SpringJoint
    242.     Collider
    243.     CapsuleCollider
    244.     BoxCollider
    245.     CharacterController
    246.     MeshCollider
    247.     SphereCollider
    248.     TerrainCollider
    249.     WheelCollider
    250.     Cloth
    251.     InteractiveCloth
    252.     SkinnedCloth
    253.     Rigidbody
    254.     Rigidbody2D
    255.     PhysicMaterial
    256.     PhysicsMaterial2D
    257.  
    258.  
    259. Graphics Category
    260.     Color n
    261.     Color32 n
    262.     Gradient
    263.     GradientAlphaKey n
    264.     GradientColorKey n
    265.     Graphics
    266.     ImageEffectOpaque
    267.     ImageEffectTransformsToLDR
    268.     Particle nodoc kinda
    269.     Particle (duplicate, has more information than other one)
    270.     ComputeBuffer
    271.     ParticleAnimator
    272.     ParticleEmitter
    273.     ParticleSystem
    274.     DrivenRectTransformTracker n (tracks a rectangle)
    275.     GL
    276.     LightmapData
    277.     MaterialPropertyBlock
    278.     ProceduralPropertyDescription
    279.     RenderBuffer n
    280.     Camera
    281.     LensFlare
    282.     Light
    283.     Projector
    284.     LODGroup
    285.     LightProbeGroup
    286.     Renderer
    287.     ClothRenderer
    288.     LineRenderer
    289.     MeshRenderer
    290.     ParticleRenderer
    291.     ParticleSystemRenderer
    292.     SkinnedMeshRenderer
    293.     SpriteRenderer
    294.     TrailRenderer
    295.     ComputeShader
    296.     Flare
    297.     LightmapSettings
    298.     LightProbes
    299.     Texture
    300.     Cubemap
    301.     MovieTexture
    302.     ProceduralTexture
    303.     RenderTexture
    304.     SparseTexture
    305.     Texture2D
    306.     Texture3D
    307.     WebCamTexture
    308.     Shader
    309.  
    310. Terrain Category
    311.     TrackedReference nodoc
    312.     SplatPrototype
    313.     TreeInstance n nodoc
    314.     TreePrototype nodoc
    315.     Types nodoc
    316.     DetailPrototype
    317.     Terrain
    318.     Tree (no documentation. Assumed this was a bin.tree until manual)
    319.     TerrainData
    320.  
    321. Misc Classes
    322.     ClothSkinningCoefficient n
    323.     LOD n
    324.     NavMeshHit n
    325.     NavMeshPath
    326.     NavMeshTriangulation n
    327.     OffMeshLinkData
    328.     LayerMask n
    329.     MissingComponentException nodoc
    330.     MissingReferenceException nodoc
    331.     NavMeshAgent
    332.     NavMeshObstacle
    333.     OffMeshLink
    334.     NavMesh
    335.     OcclusionArea
    336.     OcclusionPortal
    337.     Skybox
    338.     Font (Applies to 2D and 3D) - no duplication so putting in Misc
    339.     ScriptableObject
    340.  
    341. Main Unity Objects
    342.     Object
    343.     Component
    344.     Behaviour
    345.     MonoBehaviour -base class every script derives-
    346.     GameObject
    347.     Sprite (didn’t seem to go anywhere besides 3D Object category, too drastic of a rename would be used if I did).
     
    Rudranil95y and Darkgaze like this.