From dc420b3b0a26ac5168503491283a34ae675aba62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 14 Jun 2017 09:26:43 +0200 Subject: [PATCH] Doc: Sync classref with current source --- core/math/a_star.cpp | 2 +- doc/base/classes.xml | 108 ++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 102 insertions(+), 8 deletions(-) diff --git a/core/math/a_star.cpp b/core/math/a_star.cpp index 7a79da1cee4..7938cd0178a 100644 --- a/core/math/a_star.cpp +++ b/core/math/a_star.cpp @@ -401,7 +401,7 @@ void AStar::_bind_methods() { ObjectTypeDB::bind_method(_MD("get_point_weight_scale", "id"), &AStar::get_point_weight_scale); ObjectTypeDB::bind_method(_MD("remove_point", "id"), &AStar::remove_point); - ObjectTypeDB::bind_method(_MD("connect_points", "id", "to_id"), &AStar::connect_points, DEFVAL(true)); + ObjectTypeDB::bind_method(_MD("connect_points", "id", "to_id", "bidirectional"), &AStar::connect_points, DEFVAL(true)); ObjectTypeDB::bind_method(_MD("disconnect_points", "id", "to_id"), &AStar::disconnect_points); ObjectTypeDB::bind_method(_MD("are_points_connected", "id", "to_id"), &AStar::are_points_connected); diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 4335eddd975..c8c09e82a9e 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1,5 +1,5 @@ - + Built-in GDScript functions. @@ -2181,9 +2181,9 @@ - Weight scale has to be 1 or larger. + Add a new point at the given position. The [code]weight_scale[/code] has to be 1 or larger. @@ -2205,6 +2205,8 @@ + + @@ -13529,11 +13531,10 @@ - If true, also check if the associated script and object still exists. - The extended check is done in debug mode as part of [method GDFunctionState.resume], but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. Check whether the function call may be resumed. This is not the case if the function state was already resumed. + If [code]extended_check[/code] is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of [method GDFunctionState.resume], but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. @@ -20760,12 +20761,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -41104,6 +41137,10 @@ + + + + @@ -41710,6 +41747,14 @@ Return the collision layer. + + + + + + + + @@ -41717,6 +41762,14 @@ Return the collision mask. + + + + + + + + @@ -41909,13 +41962,21 @@ - + Set the collision layer. Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1. + + + + + + + + @@ -41924,6 +41985,14 @@ Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1. + + + + + + + + @@ -43145,6 +43214,12 @@ Emitted when a cell is selected. + + + + + + @@ -43299,6 +43374,8 @@ + + @@ -45152,6 +45229,12 @@ + + + + + + @@ -45176,6 +45259,12 @@ + + + + + + @@ -45212,6 +45301,12 @@ + + + + + + @@ -47992,7 +48087,7 @@ Sets environment properties for the entire scene - The [WorldEnvironment] node can be added to a scene in order to set default [Environment] variables for the scene. The [WorldEnvironment] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [WorldEnvironment] may be instanced in a given scene at a time. The [WorldEnvironment] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). + The [WorldEnvironment] node can be added to a scene in order to set default [Environment] variables for the scene. The [WorldEnvironment] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [WorldEnvironment] may be instanced in a given scene at a time. The [WorldEnvironment] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). @@ -48323,4 +48418,3 @@ -