SetObjectEditable: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetObjectEditable(object, EditMode)}} {{FuncParameters}} {{FuncParam|object|__EDIT_ME__}} {{FuncPa...")
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Enables a gizmo on an object. A gizmo can be used to move, rotate and scale the object with the mouse.}}


{{FuncSyntax|SetObjectEditable(object, EditMode)}}
{{FuncSyntax|SetObjectEditable(object, EditMode)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|object|__EDIT_ME__}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|EditMode|__EDIT_ME__}}
{{FuncParam|EditMode|One of the [[EditModes]].}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
See the mapeditor/client/editor.lua script in the example scripts repository. https://github.com/BlueMountainsIO/OnsetLuaScripts


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
* [[GetObjectCount]]
* [[GetObjectModelCount]]
* [[GetObjectModelGroup]]
* [[GetObjectModelName]]
* [[GetStreamedObjects]]
* [[GetObjectModel]]
* [[GetObjectLocation]]
* [[GetObjectRotation]]
* [[GetObjectScale]]
* [[GetObjectBoundingBox]]
* [[GetObjectSize]]
* [[EnableObjectHitEvents]]
* [[GetObjectMass]]
* [[SetObjectEditorSpeed]]
* [[SetObjectOutline]]
* [[SetObjectCastShadow]]
* [[SetObjectColor]]
* [[SetObjectEmissiveColor]]
* [[SetObjectTexture]]
* [[SetObjectAnimatedTexture]]

Latest revision as of 10:30, 12 May 2020

SetObjectEditable

Type: Function
Context: Client
Introduced: v1.0

Description

Enables a gizmo on an object. A gizmo can be used to move, rotate and scale the object with the mouse.

Syntax

SetObjectEditable(object, EditMode)

Parameters

  • object
    The object identifier.
  • EditMode
    One of the EditModes.

Return Value

  • Returns true on success.

Example

See the mapeditor/client/editor.lua script in the example scripts repository. https://github.com/BlueMountainsIO/OnsetLuaScripts

See also