Browse Source

Fix parameter name for String.left and String.right

Haoyu Qiu 3 years ago
parent
commit
6f38c21253
4 changed files with 20 additions and 20 deletions
  1. 12 12
      core/string/ustring.cpp
  2. 2 2
      core/string/ustring.h
  3. 2 2
      core/variant/variant_call.cpp
  4. 4 4
      doc/classes/String.xml

+ 12 - 12
core/string/ustring.cpp

@@ -3359,36 +3359,36 @@ String String::repeat(int p_count) const {
 	return new_string;
 }
 
-String String::left(int p_pos) const {
-	if (p_pos < 0) {
-		p_pos = length() + p_pos;
+String String::left(int p_len) const {
+	if (p_len < 0) {
+		p_len = length() + p_len;
 	}
 
-	if (p_pos <= 0) {
+	if (p_len <= 0) {
 		return "";
 	}
 
-	if (p_pos >= length()) {
+	if (p_len >= length()) {
 		return *this;
 	}
 
-	return substr(0, p_pos);
+	return substr(0, p_len);
 }
 
-String String::right(int p_pos) const {
-	if (p_pos < 0) {
-		p_pos = length() + p_pos;
+String String::right(int p_len) const {
+	if (p_len < 0) {
+		p_len = length() + p_len;
 	}
 
-	if (p_pos <= 0) {
+	if (p_len <= 0) {
 		return "";
 	}
 
-	if (p_pos >= length()) {
+	if (p_len >= length()) {
 		return *this;
 	}
 
-	return substr(length() - p_pos);
+	return substr(length() - p_len);
 }
 
 char32_t String::unicode_at(int p_idx) const {

+ 2 - 2
core/string/ustring.h

@@ -356,8 +356,8 @@ public:
 	int count(const String &p_string, int p_from = 0, int p_to = 0) const;
 	int countn(const String &p_string, int p_from = 0, int p_to = 0) const;
 
-	String left(int p_pos) const;
-	String right(int p_pos) const;
+	String left(int p_len) const;
+	String right(int p_len) const;
 	String indent(const String &p_prefix) const;
 	String dedent() const;
 	String strip_edges(bool left = true, bool right = true) const;

+ 2 - 2
core/variant/variant_call.cpp

@@ -1402,8 +1402,8 @@ static void _register_variant_builtin_methods() {
 	bind_method(String, to_upper, sarray(), varray());
 	bind_method(String, to_lower, sarray(), varray());
 
-	bind_method(String, left, sarray("position"), varray());
-	bind_method(String, right, sarray("position"), varray());
+	bind_method(String, left, sarray("length"), varray());
+	bind_method(String, right, sarray("length"), varray());
 
 	bind_method(String, strip_edges, sarray("left", "right"), varray(true, true));
 	bind_method(String, strip_escapes, sarray(), varray());

+ 4 - 4
doc/classes/String.xml

@@ -412,9 +412,9 @@
 		</method>
 		<method name="left" qualifiers="const">
 			<return type="String" />
-			<argument index="0" name="position" type="int" />
+			<argument index="0" name="length" type="int" />
 			<description>
-				Returns a number of characters from the left of the string. If negative [code]position[/code] is used, the characters are counted downwards from [String]'s length.
+				Returns a number of characters from the left of the string. If negative [code]length[/code] is used, the characters are counted downwards from [String]'s length.
 				Examples:
 				[codeblock]
 				print("sample text".left(3)) #prints "sam"
@@ -599,9 +599,9 @@
 		</method>
 		<method name="right" qualifiers="const">
 			<return type="String" />
-			<argument index="0" name="position" type="int" />
+			<argument index="0" name="length" type="int" />
 			<description>
-				Returns a number of characters from the right of the string. If negative [code]position[/code] is used, the characters are counted downwards from [String]'s length.
+				Returns a number of characters from the right of the string. If negative [code]length[/code] is used, the characters are counted downwards from [String]'s length.
 				Examples:
 				[codeblock]
 				print("sample text".right(3)) #prints "ext"