Skip to content

Add method Instance:ResetPropertyToDefault #872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Add method Instance:ResetPropertyToDefault #872

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a5c27e2
Add method Instance:ResetPropertyToDefault
imvanni Oct 18, 2024
ffd3b8b
Fix leading space
imvanni Oct 18, 2024
f6a7650
Fix missing code-samples
imvanni Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions content/en-us/reference/engine/classes/Instance.yaml
View file
Open in desktop
Copy link

@github-actions github-actions bot Oct 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error validating YAML against schema tools/schemas/engine/classes.json:

[
  {
    "instancePath": "/methods/26",
    "schemaPath": "#/properties/methods/items/required",
    "keyword": "required",
    "params": {
      "missingProperty": "code_samples"
    },
    "message": "must have required property 'code_samples'"
  }
]

⛔️ This change is a requirement. Please fix it before merging.

Copy link

@github-actions github-actions bot Oct 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only the following fields are editable: summary, description, deprecation_message. Other fields are automatically overwritten if edited. Please undo changes to the following fields:

  • methods.26.name
  • methods.26.code_samples
  • methods.26.code_samples
  • methods.26.parameters.0.name
  • methods.26.parameters.1
  • methods.26.parameters.1
  • methods.26.deprecation_message
  • methods.26.code-samples
  • methods.26.code-samples
  • methods.26.deprecation-message
  • methods.26.deprecation-message
  • methods.27.name
  • methods.27.code_samples
  • methods.27.parameters.0.name
  • methods.27.parameters.1.name
  • methods.27.parameters.1.type
  • methods.27.returns.0.type
  • methods.27.tags.0
  • methods.27.tags.0
  • methods.27.tags.1
  • methods.27.tags.1
  • methods.28.name
  • methods.28.code_samples
  • methods.28.parameters.0
  • methods.28.parameters.0
  • methods.28.parameters.1
  • methods.28.parameters.1
  • methods.28.returns.0.type
  • methods.28.tags.0
  • methods.28.tags.1
  • methods.28.tags.1
  • methods.29.name
  • methods.29.returns.0.type
  • methods.30.name
  • methods.30.returns.0.type
  • methods.31.name
  • methods.31.parameters.0
  • methods.31.parameters.0
  • methods.31.parameters.1
  • methods.31.parameters.1
  • methods.31.returns.0.type
  • methods.32.name
  • methods.32.parameters.0
  • methods.32.parameters.0
  • methods.32.parameters.1
  • methods.32.parameters.1
  • methods.32.returns.0.type
  • methods.33.name
  • methods.33.parameters.0
  • methods.33.parameters.0
  • methods.33.returns.0.type
  • methods.34.name
  • methods.34.parameters.0
  • methods.34.parameters.0
  • methods.34.returns.0.type
  • methods.35
  • methods.35

⛔️ This change is a requirement. Please fix it before merging.

Original file line number Diff line number Diff line change
Expand Up @@ -1237,6 +1237,29 @@ methods:
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
- name: Instance:ResetPropertyToDefault
summary: |
Resets the given property value back to its default value.
description: |
This method will reset the value of the given property back to its default value,
as defined after being created via `Datatype.Instance.new()`.
Providing an invalid property or a read-only one will result in an error.
code-samples:
parameters:
- name: name
type: string
default:
summary: |
The name of the property to be reset.
returns:
- type: void
summary: ''
tags: []
deprecation-message: ''
security: None
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
- name: Instance:SetAttribute
summary: |
Sets the attribute with the given name to the given value.
Expand Down
Loading