diff --git a/.gitignore b/.gitignore index a218e0a..f756813 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /.godot/ +/test/ diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..14124cd --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,538 @@ +Copyright (c)2023 alias blujai831 + +Any definitions which precede the row of 78 hyphens apply only +within any paragraphs preceding the row of 78 hyphens, +not within any paragraphs subsequent to the row of 78 hyphens, +and no definition subsequent to the row of 78 hyphens applies +within any paragraphs preceding the row of 78 hyphens. + +The prior paragraph is NOT to be understood to imply that if any definition +preceding the row of 78 hyphens is identical in meaning to any definition +subsequent to the row of 78 hyphens then either is rendered invalid. +In such a case, the definition preceding the row of 78 hyphens continues +to apply within any paragraphs preceding the row of 78 hyphens, +and the definition subsequent to the row of 78 hyphens continues to apply +within any paragraphs subsequent to the row of 78 hyphens, even though +the two definitions are identical in meaning. + +This Document is defined as all text between and including the instance +of "Copyright (c)2023 alias blujai831 " +that occurs above the one in this paragraph and the instance +of "this License is not intended to restrict the license of any rights +under applicable law" that occurs below the row of 78 hyphens +(and thus also below any of the ones in this paragraph). (The omission +of the period / full stop (.) in the quotation "this License is not intended +to restrict the license of any rights under applicable law" +is strictly an issue of correct grammar, and should not be taken to mean +the period / full stop at the end of This Document as thereby defined +is not also part of This Document, which in fact it is.) + +I, the Licensor (defined as alias blujai831 ), +hereby offer the Work (defined as the combined data content, +excluding This Document itself, of all files organized as descendants, +immediate or otherwise, of the immediate parent directory of any file +whose data is an ASCII encoding of This Document verbatim) subject +to This License (defined as the portion of This Document which is below, +and not above, the row of 78 hyphens). + +This License is a verbatim reproduction of Thufie's CNPLv7, +meaning her Cooperative Nonviolent Public License version 7, +but I, the Licensor, hereby declare that the Work is available +under the CNPLv7+, meaning version 7 or any later revision. + +I, the Licensor, hereby disclaim the text of This License itself +as property of Thufie, not myself. To avoid confusion with This License itself, +I will not reproduce herein the Other License under which the text +of This License itself is offered, but that Other License can be found +at the following internet address: + https://git.pixie.town/thufie/npl-builder/src/branch/main/LICENSE + +All paragraphs in This Document up to and including this paragraph, +but excluding any subsequent paragraphs, are not part of This License +and should not be mistaken as such, and should be understood to serve only +to inform the intended context in which to interpret This License. +I, the Licensor, hereby assert that because all paragraphs in This Document +up to and including this paragraph, but excluding any subsequent paragraphs, +are not part of This License, I therefore have not modified This License, +only contextualized it. As such, I assert that the requirements +which the Other License imposes upon any modified version of This License +do not apply to This Document. + +------------------------------------------------------------------------------ + +THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS +COOPERATIVE NON-VIOLENT PUBLIC LICENSE ("LICENSE"). THE WORK IS +PROTECTED BY COPYRIGHT AND ALL OTHER APPLICABLE LAWS. ANY USE OF THE +WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS +PROHIBITED. BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED IN THIS +LICENSE, YOU AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE +EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR +GRANTS YOU THE RIGHTS CONTAINED HERE IN AS CONSIDERATION FOR ACCEPTING +THE TERMS AND CONDITIONS OF THIS LICENSE AND FOR AGREEING TO BE BOUND BY +THE TERMS AND CONDITIONS OF THIS LICENSE. + +Definitions + +An Act of War is any action of one country against any group either with +an intention to provoke a conflict or an action that occurs during a +declared war or during armed conflict between military forces of any +origin. This includes but is not limited to enforcing sanctions or +sieges, supplying armed forces, or profiting from the manufacture of +tools or weaponry used in military conflict. + +An Adaptation is a work based upon the Work, or upon the Work and other +pre-existing works, such as a translation, adaptation, derivative work, +arrangement of music or other alterations of a literary or artistic +work, or phonogram or performance and includes cinematographic +adaptations or any other form in which the Work may be recast, +transformed, or adapted including in any form recognizably derived from +the original, except that a work that constitutes a Collection will not +be considered an Adaptation for the purpose of this License. For the +avoidance of doubt, where the Work is a musical work, performance or +phonogram, the synchronization of the Work in timed-relation with a +moving image ("synching") will be considered an Adaptation for the +purpose of this License. In addition, where the Work is designed to +output a neural network the output of the neural network will be +considered an Adaptation for the purpose of this license. + +Bodily Harm is any physical hurt or injury to a person that interferes +with the health or comfort of the person and that is more than merely +transient or trifling in nature. + +Distribute is to make available to the public the original and copies of +the Work or Adaptation, as appropriate, through sale, gift or any other +transfer of possession or ownership. + +Incarceration is Confinement in a jail, prison, or any other place where +individuals of any kind are held against either their will or (if their +will cannot be determined) the will of their legal guardian or +guardians. In the case of a conflict between the will of the individual +and the will of their legal guardian or guardians, the will of the +individual will take precedence. + +Licensor is The individual, individuals, entity, or entities that +offer(s) the Work under the terms of this License + +Original Author is in the case of a literary or artistic work, the +individual, individuals, entity or entities who created the Work or if +no individual or entity can be identified, the publisher; and in +addition + +- in the case of a performance the actors, singers, musicians, + dancers, and other persons who act, sing, deliver, declaim, play in, + interpret or otherwise perform literary or artistic works or + expressions of folklore; + +- in the case of a phonogram the producer being the person or legal + entity who first fixes the sounds of a performance or other sounds; + and, + +- in the case of broadcasts, the organization that transmits the + broadcast. + +Work is the literary and/or artistic work offered under the terms of +this License including without limitation any production in the +literary, scientific and artistic domain, whatever may be the mode or +form of its expression including digital form, such as a book, pamphlet +and other writing; a lecture, address, sermon or other work of the same +nature; a dramatic or dramatico-musical work; a choreographic work or +entertainment in dumb show; a musical composition with or without words; +a cinematographic work to which are assimilated works expressed by a +process analogous to cinematography; a work of drawing, painting, +architecture, sculpture, engraving or lithography; a photographic work +to which are assimilated works expressed by a process analogous to +photography; a work of applied art; an illustration, map, plan, sketch +or three-dimensional work relative to geography, topography, +architecture or science; a performance; a broadcast; a phonogram; a +compilation of data to the extent it is protected as a copyrightable +work; or a work performed by a variety or circus performer to the extent +it is not otherwise considered a literary or artistic work. + +You means an individual or entity exercising rights under this License +who has not previously violated the terms of this License with respect +to the Work, or who has received express permission from the Licensor to +exercise rights under this License despite a previous violation. + +Publicly Perform means to perform public recitations of the Work and to +communicate to the public those public recitations, by any means or +process, including by wire or wireless means or public digital +performances; to make available to the public Works in such a way that +members of the public may access these Works from a place and at a place +individually chosen by them; to perform the Work to the public by any +means or process and the communication to the public of the performances +of the Work, including by public digital performance; to broadcast and +rebroadcast the Work by any means including signs, sounds or images. + +Reproduce is to make copies of the Work by any means including without +limitation by sound or visual recordings and the right of fixation and +reproducing fixations of the Work, including storage of a protected +performance or phonogram in digital form or other electronic medium. + +Software is any digital Work which, through use of a third-party piece +of Software or through the direct usage of itself on a computer system, +the memory of the computer is modified dynamically or semi-dynamically. +"Software", secondly, processes or interprets information. + +Source Code is the human-readable form of Software through which the +Original Author and/or Distributor originally created, derived, and/or +modified it. + +Surveilling is the use of the Work to either overtly or covertly observe +and record persons and or their activities. + +A Network Service is the use of a piece of Software to interpret or +modify information that is subsequently and directly served to users +over the Internet. + +To Discriminate is use of a work to differentiate between humans in a +such a way which prioritizes some above others on the basis of percieved +membership within certain groups. + +Hate Speech is Communication or any form of expression which is solely +for the purpose of expressing hatred for some group or advocating a form +of Discrimination between humans. + +Coercion is leveraging of the threat of force or use of force to +intimidate a person in order to gain compliance, or to offer large +incentives which aim to entice a person to act against their will. + +Fair Dealing Rights + +Nothing in this License is intended to reduce, limit, or restrict any +uses free from copyright or rights arising from limitations or +exceptions that are provided for in connection with the copyright +protection under copyright law or other applicable laws. + +License Grant + +Subject to the terms and conditions of this License, Licensor hereby +grants You a worldwide, royalty-free, non-exclusive, perpetual (for the +duration of the applicable copyright) license to exercise the rights in +the Work as stated below: + +To Reproduce the Work, to incorporate the Work into one or more +Collections, and to Reproduce the Work as incorporated in the +Collections + +To create and Reproduce Adaptations provided that any such Adaptation, +including any translation in any medium, takes reasonable steps to +clearly label, demarcate or otherwise identify that changes were made to +the original Work. For example, a translation could be marked "The +original work was translated from English to Spanish," or a modification +could indicate "The original work has been modified." + +To Distribute and Publicly Perform the Work including as incorporated in +Collections. + +To Distribute and Publicly Perform Adaptations. The above rights may be +exercised in all media and formats whether now known or hereafter +devised. The above rights include the right to make such modifications +as are technically necessary to exercise the rights in other media and +formats. This License constitutes the entire agreement between the +parties with respect to the Work licensed here. There are no +understandings, agreements or representations with respect to the Work +not specified here. Licensor shall not be bound by any additional +provisions that may appear in any communication from You. This License +may not be modified without the mutual written agreement of the Licensor +and You. All rights not expressly granted by Licensor are hereby +reserved, including but not limited to the rights set forth in +Non-waivable Compulsory License Schemes, Waivable Compulsory License +Schemes, and Voluntary License Schemes in the restrictions. + +Restrictions + +The license granted in the license grant above is expressly made subject +to and limited by the following restrictions: + +You may Distribute or Publicly Perform the Work only under the terms of +this License. You must include a copy of, or the Uniform Resource +Identifier (URI) for, this License with every copy of the Work You +Distribute or Publicly Perform. You may not offer or impose any terms on +the Work that restrict the terms of this License or the ability of the +recipient of the Work to exercise the rights granted to that recipient +under the terms of the License. You may not sublicense the Work. You +must keep intact all notices that refer to this License and to the +disclaimer of warranties with every copy of the Work You Distribute or +Publicly Perform. When You Distribute or Publicly Perform the Work, You +may not impose any effective technological measures on the Work that +restrict the ability of a recipient of the Work from You to exercise the +rights granted to that recipient under the terms of the License. This +Section applies to the Work as incorporated in a Collection, but this +does not require the Collection apart from the Work itself to be made +subject to the terms of this License. If You create a Collection, upon +notice from any Licensor You must, to the extent practicable, remove +from the Collection any credit as requested. If You create an +Adaptation, upon notice from any Licensor You must, to the extent +practicable, remove from the Adaptation any credit as requested. + +Commercial Restrictions + +You may not exercise any of the rights granted to You in the above +section in any manner that is primarily intended for or directed toward +commercial advantage or private monetary compensation unless you meet +the following requirements. + +i. You are a worker-owned business or worker-owned collective. + +ii. after tax, all financial gain, surplus, profits and benefits + produced by the business or collective are distributed among the + worker-owners unless a set amount is to be allocated towards + community projects as decided by a previously-established consensus + agreement between the worker-owners where all worker-owners agreed. + +iii. You are not using such rights on behalf of a business other than + those specified in (i) or (ii) above, nor are using such rights as + a proxy on behalf of a business with the intent to circumvent the + aforementioned restrictions on such a business. + +The exchange of the Work for other copyrighted works by means of digital +file-sharing or otherwise shall not be considered to be intended for or +directed toward commercial advantage or private monetary compensation, +provided there is no payment of any monetary compensation in connection +with the exchange of copyrighted works. + +If the Work meets the definition of Software, You may exercise the +rights granted in the license grant only if You provide a copy of the +corresponding Source Code from which the Work was derived in digital +form, or You provide a URI for the corresponding Source Code of the +Work, to any recipients upon request. + +If the Work is used as or for a Network Service, You may exercise the +rights granted in the license grant only if You provide a copy of the +corresponding Source Code from which the Work was derived in digital +form, or You provide a URI for the corresponding Source Code to the +Work, to any recipients of the data served or modified by the Web +Service. + +Any use by a business that is privately owned and managed, and that +seeks to generate profit from the labor of employees paid by salary or +other wages, is not permitted under this license. + +You may exercise the rights granted in the license grant for any +purposes only if: + +i. You do not use the Work for the purpose of inflicting Bodily Harm on + human beings (subject to criminal prosecution or otherwise) outside + of providing medical aid or undergoing a voluntary procedure under + no form of Coercion. + +ii. You do not use the Work for the purpose of Surveilling or tracking + individuals for financial gain. + +iii. You do not use the Work in an Act of War. + +iv. You do not use the Work for the purpose of supporting or profiting + from an Act of War. + +v. You do not use the Work for the purpose of Incarceration. + +vi. You do not use the Work for the purpose of extracting, processing, + or refining, oil, gas, or coal. Or to in any other way to + deliberately pollute the environment as a byproduct of manufacturing + or irresponsible disposal of hazardous materials. + +vii. You do not use the Work for the purpose of expediting, + coordinating, or facilitating paid work undertaken by individuals + under the age of 12 years. + +viii. You do not use the Work to either Discriminate or spread Hate + Speech on the basis of sex, sexual orientation, gender identity, + race, age, disability, color, national origin, religion, caste, or + lower economic status. + +If You Distribute, or Publicly Perform the Work or any Adaptations or +Collections, You must, unless a request has been made by any Licensor to +remove credit from a Collection or Adaptation, keep intact all copyright +notices for the Work and provide, reasonable to the medium or means You +are utilizing: + +i. the name of the Original Author (or pseudonym, if applicable) if + supplied, and/or if the Original Author and/or Licensor designate + another party or parties (e.g., a sponsor institute, publishing + entity, journal) for attribution ("Attribution Parties") in + Licensor's copyright notice, terms of service or by other reasonable + means, the name of such party or parties; + +ii. the title of the Work if supplied; + +iii. to the extent reasonably practicable, the URI, if any, that + Licensor to be associated with the Work, unless such URI does not + refer to the copyright notice or licensing information for the + Work; and, + +iv. in the case of an Adaptation, a credit identifying the use of the + Work in the Adaptation (e.g., "French translation of the Work by + Original Author," or "Screenplay based on original Work by Original + Author"). + +If any Licensor has sent notice to request removing credit, You must, to +the extent practicable, remove any credit as requested. The credit +required by this Section may be implemented in any reasonable manner; +provided, however, that in the case of an Adaptation or Collection, at a +minimum such credit will appear, if a credit for all contributing +authors of the Adaptation or Collection appears, then as part of these +credits and in a manner at least as prominent as the credits for the +other contributing authors. For the avoidance of doubt, You may only use +the credit required by this Section for the purpose of attribution in +the manner set out above and, by exercising Your rights under this +License, You may not implicitly or explicitly assert or imply any +connection with, sponsorship or endorsement by the Original Author, +Licensor and/or Attribution Parties, as appropriate, of You or Your use +of the Work, without the separate, express prior written permission of +the Original Author, Licensor and/or Attribution Parties. + +Non-waivable Compulsory License Schemes. In those jurisdictions in which +the right to collect royalties through any statutory or compulsory +licensing scheme cannot be waived, the Licensor reserves the exclusive +right to collect such royalties for any exercise by You of the rights +granted under this License + +Waivable Compulsory License Schemes. In those jurisdictions in which the +right to collect royalties through any statutory or compulsory licensing +scheme can be waived, the Licensor reserves the exclusive right to +collect such royalties for any exercise by You of the rights granted +under this License if Your exercise of such rights is for a purpose or +use which is otherwise than noncommercial as permitted under Commercial +Restrictions and otherwise waives the right to collect royalties through +any statutory or compulsory licensing scheme. + +Voluntary License Schemes. The Licensor reserves the right to collect +royalties, whether individually or, in the event that the Licensor is a +member of a collecting society that administers voluntary licensing +schemes, via that society, from any exercise by You of the rights +granted under this License that is for a purpose or use which is +otherwise than noncommercial as permitted under the license grant. + +Except as otherwise agreed in writing by the Licensor or as may be +otherwise permitted by applicable law, if You Reproduce, Distribute or +Publicly Perform the Work either by itself or as part of any Adaptations +or Collections, You must not distort, mutilate, modify or take other +derogatory action in relation to the Work which would be prejudicial to +the Original Author's honor or reputation. Licensor agrees that in those +jurisdictions (e.g. Japan), in which any exercise of the right granted +in the license grant of this License (the right to make Adaptations) +would be deemed to be a distortion, mutilation, modification or other +derogatory action prejudicial to the Original Author's honor and +reputation, the Licensor will waive or not assert, as appropriate, this +Section, to the fullest extent permitted by the applicable national law, +to enable You to reasonably exercise Your right under the license grant +of this License (right to make Adaptations) but not otherwise. + +Do not make any legal claim against anyone accusing the Work, with or +without changes, alone or with other works, of infringing any patent +claim. + +Representations Warranties and Disclaimer + +UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR +OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY +KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, +INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, +FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF +LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, +WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE +EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU. + +Limitation on Liability + +EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL +LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, +INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF +THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED +OF THE POSSIBILITY OF SUCH DAMAGES. + +Termination + +This License and the rights granted hereunder will terminate +automatically upon any breach by You of the terms of this License. +Individuals or entities who have received Adaptations or Collections +from You under this License, however, will not have their licenses +terminated provided such individuals or entities remain in full +compliance with those licenses. The Sections on definitions, fair +dealing rights, representations, warranties, and disclaimer, limitation +on liability, termination, and revised license versions will survive any +termination of this License. + +Subject to the above terms and conditions, the license granted here is +perpetual (for the duration of the applicable copyright in the Work). +Notwithstanding the above, Licensor reserves the right to release the +Work under different license terms or to stop distributing the Work at +any time; provided, however that any such election will not serve to +withdraw this License (or any other license that has been, or is +required to be, granted under the terms of this License), and this +License will continue in full force and effect unless terminated as +stated above. + +Revised License Versions + +This License may receive future revisions in the original spirit of the +license intended to strengthen This License. Each version of This +License has an incrementing version number. + +Unless otherwise specified like in the below subsection The Licensor has +only granted this current version of This License for The Work. In this +case future revisions do not apply. + +The Licensor may specify that the latest available revision of This +License be used for The Work by either explicitly writing so or by +suffixing the License URI with a "+" symbol. + +The Licensor may specify that The Work is also available under the terms +of This License's current revision as well as specific future revisions. +The Licensor may do this by writing it explicitly or suffixing the +License URI with any additional version numbers each separated by a +comma. + +Miscellaneous + +Each time You Distribute or Publicly Perform the Work or a Collection, +the Licensor offers to the recipient a license to the Work on the same +terms and conditions as the license granted to You under this License. + +Each time You Distribute or Publicly Perform an Adaptation, Licensor +offers to the recipient a license to the original Work on the same terms +and conditions as the license granted to You under this License. + +If the Work is classified as Software, each time You Distribute or +Publicly Perform an Adaptation, Licensor offers to the recipient a copy +and/or URI of the corresponding Source Code on the same terms and +conditions as the license granted to You under this License. + +If the Work is used as a Network Service, each time You Distribute or +Publicly Perform an Adaptation, or serve data derived from the Software, +the Licensor offers to any recipients of the data a copy and/or URI of +the corresponding Source Code on the same terms and conditions as the +license granted to You under this License. + +If any provision of this License is invalid or unenforceable under +applicable law, it shall not affect the validity or enforceability of +the remainder of the terms of this License, and without further action +by the parties to this agreement, such provision shall be reformed to +the minimum extent necessary to make such provision valid and +enforceable. + +No term or provision of this License shall be deemed waived and no +breach consented to unless such waiver or consent shall be in writing +and signed by the party to be charged with such waiver or consent. + +This License constitutes the entire agreement between the parties with +respect to the Work licensed here. There are no understandings, +agreements or representations with respect to the Work not specified +here. Licensor shall not be bound by any additional provisions that may +appear in any communication from You. This License may not be modified +without the mutual written agreement of the Licensor and You. + +The rights granted under, and the subject matter referenced, in this +License were drafted utilizing the terminology of the Berne Convention +for the Protection of Literary and Artistic Works (as amended on +September 28, 1979), the Rome Convention of 1961, the WIPO Copyright +Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and +the Universal Copyright Convention (as revised on July 24, 1971). These +rights and subject matter take effect in the relevant jurisdiction in +which the License terms are sought to be enforced according to the +corresponding provisions of the implementation of those treaty +provisions in the applicable national law. If the standard suite of +rights granted under applicable copyright law includes additional rights +not granted under this License, such additional rights are deemed to be +included in the License; this License is not intended to restrict the +license of any rights under applicable law. diff --git a/autoload/Wait/Wait.gd b/autoload/Wait/Wait.gd new file mode 100644 index 0000000..a605f83 --- /dev/null +++ b/autoload/Wait/Wait.gd @@ -0,0 +1,50 @@ +extends Node +## Global reference point node for tick-based delays. +## +## Serves as a terser alternative to SceneTreeTimer. + +signal _ticked(delay: float) + +func _ready() -> void: + process_mode = Node.PROCESS_MODE_ALWAYS + +func _process(delta: float) -> void: + _ticked.emit(delta) + +## Waits one tick. Returns the tick's duration. +func tick() -> float: + return await _ticked + +## Waits n ticks. Returns the total duration. +func ticks(n: int) -> float: + var duration: float = 0.0 + for _dont_care in n: + duration += await _ticked + return duration + +## Waits approximately n seconds. Returns the actual duration waited. +func seconds(n: float) -> float: + var duration: float = 0.0 + while duration < n: + duration += await _ticked + return duration + +## Waits until condition is fulfilled. Returns the duration waited. +func until(p: Callable) -> float: + var duration: float = 0.0 + # Wrap condition in case it is a coroutine. + var task := Task.new(p) + while true: + # Wait for task, but do not actually await it, + # because we need to tally the time waited in the meantime. + while not task.is_finished(): + duration += await _ticked + # Task is supposed to be a condition, not just any task. + # Therefore, even when it finishes, only conclude waiting + # if its result was affirmative (meaning the condition has been met); + # otherwise, repeat the task. + if task.result: + break + else: + task = Task.new(p) + return duration diff --git a/project.godot b/project.godot index b23eb58..b7f81b6 100644 --- a/project.godot +++ b/project.godot @@ -13,3 +13,7 @@ config_version=5 config/name="Stick the Quick" config/features=PackedStringArray("4.3", "Forward Plus") config/icon="res://icon.svg" + +[autoload] + +Wait="*res://autoload/Wait/Wait.gd" diff --git a/util/StrictSingleton.gd b/util/StrictSingleton.gd new file mode 100644 index 0000000..4271311 --- /dev/null +++ b/util/StrictSingleton.gd @@ -0,0 +1,6 @@ +class_name StrictSingleton extends Object +## Base class for "strict" singletons which do not allow instantiation. + +func _init() -> void: + push_error("Not instantiable") + free() diff --git a/util/Task.gd b/util/Task.gd new file mode 100644 index 0000000..b37ddbc --- /dev/null +++ b/util/Task.gd @@ -0,0 +1,37 @@ +class_name Task extends RefCounted +## Promise-like abstraction for (hopefully) safer concurrency. + +signal _sig_finished + +## Value returned by task. Null if, but not only if, task has not finished. +var result: Variant = null +var _finished := false + +## Awaits the given Callable concurrently and reports back when it finishes. +func _init(thunk: Callable) -> void: + var coro := func() -> void: + result = await thunk.call() + _finished = true + _sig_finished.emit() + coro.call() + +## Returns true iff the task has finished. +func is_finished() -> bool: + return _finished + +## Waits for the task to finish (if necessary) and returns its result. +func sync() -> Variant: + if not _finished: + await _sig_finished + return result + +## Creates a Task which can only finish when all subtasks have finished. +## +## Returns an array of the tasks' results in the same respective order. +static func group(subtasks: Array[Task]) -> Task: + var thunk := func() -> Array: + var results := [] + for task in subtasks: + results.push_back(await task.sync()) + return results + return Task.new(thunk) diff --git a/util/TimeExt.gd b/util/TimeExt.gd new file mode 100644 index 0000000..5ca80c0 --- /dev/null +++ b/util/TimeExt.gd @@ -0,0 +1,58 @@ +class_name TimeExt extends StrictSingleton +## Extension methods for Time class. + +## Returns the current number of seconds since the Epoch. +static func get_current_unix_time() -> int: + return Time.get_unix_time_from_datetime_dict( + Time.get_datetime_dict_from_system() + ) + +## Returns a string representation of the given number of system time seconds. +## +## Format is [minus] [N seconds|N minutes N seconds|N hours N minutes|N days]. +## See function body comments for specific details. +static func format_systime_interval(seconds: int) -> String: + var neg: bool = seconds < 0 + seconds = abs(seconds) + # If 0 minutes, report only seconds. + if seconds < 60: + return "%s%d seconds" % [ + 'minus ' if neg else '', + seconds + ] + # If 0 hours, report only minutes and seconds. + elif seconds < 3600: + return "%s%d minutes %d seconds" % [ + 'minus ' if neg else '', + int(seconds/60.0), seconds%60 + ] + # If 0 days, report only hours and minutes, and regard seconds + # as probably too small in comparison to be of any interest. + elif seconds < 86400: + return "%s%d hours %02d minutes" % [ + 'minus ' if neg else '', + int(seconds/3600.0), + int(seconds/60.0)%60 + ] + # If >0 days, report only days, and regard everything else + # as probably too small in comparison to be of any interest. + else: + return "%s%d days" % [ + 'minus ' if neg else '', + int(seconds/86400.0) + ] + +## Returns a string representation of the given number of realtime seconds. +## +## Format is [-]HH:MM:SS:TT (where T stands for pars minuta [t]ertia, +## more commonly known as the typical duration of one frame). +static func format_realtime_interval(seconds: float) -> String: + var neg: bool = seconds < 0.0 + seconds = abs(seconds) + return "%s%d:%02d:%02d:%02d" % [ + '-' if neg else '', + int(seconds/3600.0), + int(seconds/60.0)%60, + int(seconds)%60, + int(seconds*60.0)%60 + ]