Celestia/Celx Scripting/CELX Lua Methods/CEL command unmark

From Wikibooks, open books for an open world
Jump to navigation Jump to search

unmark[edit | edit source]

unmark { object <string> }

If an object was previously marked, this command unmarks it.

Arguments:

object <string>
Defines the name of the object you want to unmark. No default.


CELX equivalent-1:

Based on the celestia:unmark() method.

  • Find the object with name <string> to be unmarked and store in "objectname".
objectname = celestia:find( <string> )
  • Remove marker on "objectname" using Celestia method.
celestia:unmark(objectname)

Summarized:

objectname = celestia:find( <string> )
celestia:unmark(objectname)


CELX equivalent-2:

Based on the object:unmark() method.

  • Find the object with name <string> to be unmarked and store in "objectname".
objectname = celestia:find( <string> )

  • Remove marker on "objectname" using object method.
objectname:unmark()

Summarized:

objectname = celestia:find( <string> )
objectname:unmark()

Example:
This example unmarks Earth.

CEL:

unmark { object "Sol/Earth" }

CELX with the celestia:unmark() method:

earth = celestia:find("Sol/Earth")
celestia:unmark(earth)

CELX with the object:unmark() method:

earth = celestia:find("Sol/Earth")
earth:unmark()


Back to CEL command index