From dd462f512d7b7759f5e1a7b77698b843f5388a31 Mon Sep 17 00:00:00 2001 From: Haoyu Qiu Date: Sat, 8 Jan 2022 22:39:00 +0800 Subject: [PATCH] Misc documentation improvements --- doc/classes/InputEventMIDI.xml | 2 +- doc/classes/NavigationAgent.xml | 2 +- doc/classes/NavigationAgent2D.xml | 2 +- doc/classes/NavigationObstacle2D.xml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/classes/InputEventMIDI.xml b/doc/classes/InputEventMIDI.xml index 132936b8cc3..6cc652817ec 100644 --- a/doc/classes/InputEventMIDI.xml +++ b/doc/classes/InputEventMIDI.xml @@ -30,7 +30,7 @@ The instrument of this input event. This value ranges from 0 to 127. Refer to the instrument list on the General MIDI wikipedia article to see a list of instruments, except that this value is 0-index, so subtract one from every number on that chart. A standard piano will have an instrument number of 0. - Returns a value indicating the type of message for this MIDI signal. This is a member of the MidiMessageList enum. + Returns a value indicating the type of message for this MIDI signal. This is a member of the [enum @GlobalScope.MidiMessageList] enum. For MIDI messages between 0x80 and 0xEF, only the left half of the bits are returned as this value, as the other part is the channel (ex: 0x94 becomes 0x9). For MIDI messages from 0xF0 to 0xFF, the value is returned as-is. Notes will return [code]MIDI_MESSAGE_NOTE_ON[/code] when activated, but they might not always return [code]MIDI_MESSAGE_NOTE_OFF[/code] when deactivated, therefore your code should treat the input as stopped if some period of time has passed. For more information, see the MIDI message status byte list chart linked above. diff --git a/doc/classes/NavigationAgent.xml b/doc/classes/NavigationAgent.xml index 9f20025117d..1ba47c71941 100644 --- a/doc/classes/NavigationAgent.xml +++ b/doc/classes/NavigationAgent.xml @@ -87,7 +87,7 @@ - Sends the given velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the [signal velocity_computed] signal. + Sends the passed in velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the [signal velocity_computed] signal. diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index bc3fa79c8c4..0ac9841d274 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -18,7 +18,7 @@ - Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. + Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame. diff --git a/doc/classes/NavigationObstacle2D.xml b/doc/classes/NavigationObstacle2D.xml index 868f659bc23..adaad7457dc 100644 --- a/doc/classes/NavigationObstacle2D.xml +++ b/doc/classes/NavigationObstacle2D.xml @@ -4,7 +4,7 @@ 2D obstacle used in navigation for collision avoidance. - 2D obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. This can be done by having the obstacle as a child of a [Navigation2D] node, or using [method set_navigation]. [NavigationObstacle] is physics safe. + 2D obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. This can be done by having the obstacle as a child of a [Navigation2D] node, or using [method set_navigation]. [NavigationObstacle2D] is physics safe.