Skip to content

Commit ac8a78f

Browse files
committed
docs: Update
1 parent bad8e82 commit ac8a78f

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

Assets/JCSUnity/Scripts/UI/JCS_Canvas.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,14 @@ public void AddComponentToResizeCanvas(Component com)
146146
FitScreenSize(rect);
147147
}
148148

149+
/// <summary>
150+
/// Return true if the canvas is currently visible.
151+
/// </summary>
152+
public bool IsShown()
153+
{
154+
return mCanvas.enabled;
155+
}
156+
149157
/// <summary>
150158
/// Show the canvas so it's visible.
151159
/// </summary>
@@ -166,14 +174,6 @@ public void Hide(bool mute = false)
166174
JCS_SoundPlayer.PlayByAttachment(mActiveSound, JCS_SoundMethod.PLAY_SOUND);
167175
}
168176

169-
/// <summary>
170-
/// Return true if the canvas is currently visible.
171-
/// </summary>
172-
public bool IsShown()
173-
{
174-
return mCanvas.enabled;
175-
}
176-
177177
/// <summary>
178178
/// Toggle the canvas' visibility.
179179
/// </summary>

docs/ScriptReference/UI/JCS_Canvas.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Control of the canvas component.
1717
|:---------------------------|:--------------------------------------------------------------|
1818
| GuessCanvas | Return the `canvas` that is the parent of the `trans` object. |
1919
| AddComponentToResizeCanvas | Add component to resize canvas. |
20+
| IsShown | Return true if the canvas is currently visible. |
2021
| Show | Show the canvas, so it's visible on the screen. |
2122
| Hide | Hide the canvas, so it's invisible on the screen. |
2223
| ToggleVisibility | Toggle the canvas' visibility. |

0 commit comments

Comments
 (0)