BaseParams Class |
Input params to be passed to Init
This can be used Monobehaviour's field and exposed via inspector (most common case)
Or can be manually constructed, depending on what's easier in your context
Inheritance HierarchySystemObject
Com.ForbiddenByte.OSA.CoreBaseParams
Com.ForbiddenByte.OSA.CustomAdapters.GridViewGridParams
Com.ForbiddenByte.OSA.CustomParamsBaseParamsWithPrefab
Com.ForbiddenByte.OSA.Demos.MultiplePrefabsMyParams
Com.ForbiddenByte.OSA.CoreBaseParams
Com.ForbiddenByte.OSA.CustomAdapters.GridViewGridParams
Com.ForbiddenByte.OSA.CustomParamsBaseParamsWithPrefab
Com.ForbiddenByte.OSA.Demos.MultiplePrefabsMyParams
Namespace: Com.ForbiddenByte.OSA.Core
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxC#
[SerializableAttribute] public class BaseParams
The BaseParams type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BaseParams | It's here just so the class can be serialized by Unity when used as a MonoBehaviour's field |
Properties| Name | Description | |
|---|---|---|
 | content | Obsolete. |
| Content | |
| contentGravity | Obsolete. |
| contentPadding | Obsolete. |
| ContentPadding | Padding for the 4 edges of the content panel |
| contentSpacing | Obsolete. |
| ContentSpacing | Spacing between items (horizontal if the ScrollView is horizontal. else, vertical) |
| DefaultItemSize | The size of all items for which the size is not specified |
| DragEnabled |
Allows you to click and drag the content directly (enabled by default).
The ForwardDragToParents is not affected by this.
NOTE: Do not change this property during a drag event (i.e. when IsDragging is true)
|
| ForwardDragToParents | You'll probably need this if the scroll view is a child of another scroll view.
If enabled, the first parent that implements all of IInitializePotentialDragHandler, IBeginDragHandler, IDragHandler and IEndDragHandler will be informed
about these events when they occur on this scroll view. This works both with Unity's ScrollRect and OSA |
| galleryEffectAmount | Obsolete. |
| galleryEffectViewportPivot | Obsolete. |
| Gravity |
The effect of this property can only be seen when the content size is smaller than the viewport, case in which there are 3 possibilities:
place the content at the start, middle or end. FROM_PIVOT doesn't change the content's position (it'll be preserved from the way you aligned it in edit-mode)
|
| IsHorizontal | |
| loopItems | Obsolete. |
| orientation | Obsolete. |
| Orientation | |
| recycleBinCapacity | Obsolete. |
| scrollbar | Obsolete. |
| Scrollbar | |
| ScrollEnabled |
Allows you to scroll by mouse wheel or other similar input devices (enabled by default).
The ForwardDragToParents is not affected by this.
NOTE: Do not change this property during a drag event (i.e. when IsDragging is true)
|
| ScrollSensivity | The sensivity to the Mouse's scrolling wheel or similar input methods. Not related to dragging or scrolling via scrollbar |
| ScrollViewRT | |
| Snapper | |
| TransientSpeedBetweenDrags | If enabled, multiple drags in the same direction will lead to greater speeds |
| viewport | Obsolete. |
| Viewport | If null, ScrollViewRT is considered to be the viewport |
Methods| Name | Description | |
|---|---|---|
| GetAbstractNormalizedScrollPosition | Obsolete. |
| InitIfNeeded |
Called internally in Init and every time the scrollview's size changes.
This makes sure the content and viewport have valid values. It can also be overridden to initialize custom data
|
| MigrateFieldsToVersion4 | |
| UpdateContentPivotFromGravityType |
Fields| Name | Description | |
|---|---|---|
 | effects | |
| optimization |
Version InformationOptimized ScrollView Adapter
Supported in: 4.1See Also