Figments-of-the-Night/addons/inkgd/runtime/values/variable_pointer_value.gd
Gerard Gascón b99855351d init
2025-04-24 17:23:34 +02:00

69 lines
2.1 KiB
GDScript

# warning-ignore-all:shadowed_variable
# warning-ignore-all:unused_class_variable
# ############################################################################ #
# Copyright © 2015-2021 inkle Ltd.
# Copyright © 2019-2022 Frédéric Maquin <fred@ephread.com>
# All Rights Reserved
#
# This file is part of inkgd.
# inkgd is licensed under the terms of the MIT license.
# ############################################################################ #
extends InkValue
class_name InkVariablePointerValue
# ############################################################################ #
var variable_name : get = get_variable_name, set = set_variable_name # InkPath
func get_variable_name():
return value
func set_variable_name(value):
self.value = value
func get_value_type():
return ValueType.VARIABLE_POINTER
func get_is_truthy():
InkUtils.throw_exception("Shouldn't be checking the truthiness of a variable pointer")
return false
var context_index = 0 # int
func _init_with_context(variable_name, context_index = -1):
super._init_with(variable_name)
self.context_index = context_index
func _init():
value = null
# The method takes a `StoryErrorMetadata` object as a parameter that
# doesn't exist in upstream. The metadat are used in case an 'exception'
# is raised. For more information, see story.gd.
func cast(new_type, metadata = null):
if new_type == self.value_type:
return self
InkUtils.throw_story_exception(bad_cast_exception_message(new_type), false, metadata)
return null
func _to_string() -> String:
return "VariablePointerValue(" + self.variable_name + ")"
func copy():
return VariablePointerValue().new_with_context(self.variable_name, context_index)
# ######################################################################## #
# GDScript extra methods
# ######################################################################## #
func is_ink_class(type):
return type == "VariablePointerValue" || super.is_ink_class(type)
func get_ink_class():
return "VariablePointerValue"
static func new_with_context(variable_name, context_index = -1):
var value = VariablePointerValue().new()
value._init_with_context(variable_name, context_index)
return value