Index · Object → RefCounted → Resource → SyntaxHighlighter → CodeHighlighter

CodeHighlighter

A syntax highlighter intended for code.

Class Description

By adjusting various properties of this resource, you can change the colors of strings, comments, numbers, and other text patterns inside a TextEdit control.

Properties

var color_regions: Dictionary = {}

Sets the color regions. All existing regions will be removed. The Dictionary key is the region start and end key, separated by a space. The value is the region color.

var function_color: Color = Color(0, 0, 0, 1)

Sets color for functions. A function is a non-keyword string followed by a '('.

var keyword_colors: Dictionary = {}

Sets the keyword colors. All existing keywords will be removed. The Dictionary key is the keyword. The value is the keyword color.

var member_keyword_colors: Dictionary = {}

Sets the member keyword colors. All existing member keyword will be removed. The Dictionary key is the member keyword. The value is the member keyword color.

var member_variable_color: Color = Color(0, 0, 0, 1)

Sets color for member variables. A member variable is non-keyword, non-function string proceeded with a '.'.

var number_color: Color = Color(0, 0, 0, 1)

Sets the color for numbers.

var symbol_color: Color = Color(0, 0, 0, 1)

Sets the color for symbols.

Inherited from Resource (4)

Methods

func add_color_region(start_key: String, end_key: String, color: Color, line_only: bool = false) -> void

Adds a color region (such as for comments or strings) from start_key to end_key. Both keys should be symbols, and start_key must not be shared with other delimiters.

If line_only is true or end_key is an empty String, the region does not carry over to the next line.

func add_keyword_color(keyword: String, color: Color) -> void

Sets the color for a keyword.

The keyword cannot contain any symbols except '_'.

func add_member_keyword_color(member_keyword: String, color: Color) -> void

Sets the color for a member keyword.

The member keyword cannot contain any symbols except '_'.

It will not be highlighted if preceded by a '.'.

func clear_color_regions() -> void

Removes all color regions.

func clear_keyword_colors() -> void

Removes all keywords.

func clear_member_keyword_colors() -> void

Removes all member keywords.

func get_keyword_color(keyword: String) -> Color

Returns the color for a keyword.

func get_member_keyword_color(member_keyword: String) -> Color

Returns the color for a member keyword.

func has_color_region(start_key: String) -> bool

Returns true if the start key exists, else false.

func has_keyword_color(keyword: String) -> bool

Returns true if the keyword exists, else false.

func has_member_keyword_color(member_keyword: String) -> bool

Returns true if the member keyword exists, else false.

func remove_color_region(start_key: String) -> void

Removes the color region that uses that start key.

func remove_keyword_color(keyword: String) -> void

Removes the keyword.

func remove_member_keyword_color(member_keyword: String) -> void

Removes the member keyword.

Inherited from SyntaxHighlighter (7)
func _update_cache() -> void
func update_cache() -> void
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)